HTTP Request
GET
/v1/rateAuth: Signed API key required
Permissions: UserData
Signed Location: Query string
Get the displayed customer rate for a fiat pair.
Headers
| Parameter Name | Required | Type | Notes |
|---|---|---|---|
| X-MBX-APIKEY | true | string | Provisioned ACCESS_ID. x-access-id is also accepted by the backend, but X-MBX-APIKEY is recommended. |
Request Parameters
| Parameter Name | Required | Type | Notes |
|---|---|---|---|
| base_currency | true | string | Base currency; must exist in the fiat list. |
| quote_currency | true | string | Quote currency; CNY is normalized to CNA. |
| timestamp | true | int64 | Request timestamp in milliseconds. Microseconds are also accepted and normalized by the server. |
| recvWindow | false | integer | Optional receive window. Default 5000, maximum 60000. |
| signature | true | string | HMAC-SHA256 signature of the signed payload. RSA and Ed25519 are also supported when provisioned. |
Return Parameters
| Parameter Name | Required | Type | Notes |
|---|---|---|---|
| data.base_currency | true | string | Base currency. |
| data.quote_currency | true | string | Quote currency. |
| data.rate | true | string | Rate in the base/quote direction. |
| data.inverse_rate | true | string | Inverse rate. |
| data.detail | false | object | Extended information returned by the backend. |
Request Example
curl 'https://<host>/v1/rate?base_currency=NGN"e_currency=GHS×tamp=<TIMESTAMP>&recvWindow=5000&signature=<SIGNATURE>' \
-H 'X-MBX-APIKEY: <ACCESS_ID>'