List Currencies

GET 
https://api-baas-hml.zrobank.xyz/v1/operations/currencies

Retrieve a list of all available and tradable currencies. Optional filter parameters can be used to refine your search.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [id]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

symbol string

Currency Symbol.

Header Parameters

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

The product ID is a UUID (v4) used to identify the Z.ro product configuration.

x-product-target-user-uuid string

The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses

200

The currencies returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Currencies data.
Array [
id numberrequired
Currency ID.
title stringrequired
Currency title.
symbol stringrequired
Currency symbol.
symbol_align stringrequired
Possible values: [left, right]
Currency symbol align position.
decimal numberrequired
Currency decimal value.
tag stringrequired
Currency tag.
state stringrequired
Possible values: [active, deactivate]
Currency state.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": 0,
      "title": "string",
      "symbol": "string",
      "symbol_align": "left",
      "decimal": 0,
      "tag": "string",
      "state": "active"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api-baas-hml.zrobank.xyz/v1/operations/currencies' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://api-baas-hml.zrobank.xyz

Auth

Bearer Token

Parameters

nonce — headerrequired

page — query

size — query

sort — query

---id

order — query

---ascdesc

symbol — query

x-lang — header

---pt-BRen-US

x-product-uuid — header

x-product-target-user-uuid — header

ResponseClear

Click the Send API Request button above and see the response here!