Account
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
Get current foreign exchange rates for all currency pairs used in your account.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
base | string | Optional | Base currency, e.g. `USD`. Omit for all pairs. |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
exchanges | object[] | Optional | List of exchange rates |
└ base_currency | string | Optional | Base currency |
└ other_currency | string | Optional | Quote currency |
└ bid_rate | number | Optional | Bid rate |
└ offer_rate | number | Optional | Offer rate |
└ average_rate | number | Optional | Average exchange rate: the value of 1 `other_currency` in `base_currency`. For example, `base_currency=USD`, `other_currency=HKD`, `average_rate=0.12746` means 1 HKD = 0.12746 USD |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"exchanges": [
{
"base_currency": "USD",
"other_currency": "HKD",
"bid_rate": 0.12746,
"offer_rate": 0.12746,
"average_rate": 0.12746
}
]
}
}Error code
See the Error Codes page for the full list of error codes.