Home/Balance

Get Balances

Last Updated: 2026-05-29

HTTP Request

GET/v1/balance

Auth: Signed API key required

Permissions: UserData

Signed Location: Query string

Get customer balances, pending deposit/withdraw values, totals, and balance rows grouped by currency.

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.

Parameter Name	Required	Type	Notes
currency	false	string	Preferred quote currency; when omitted, the customer preference is used.
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.

Parameter Name	Required	Type	Notes
data.currency	true	string	Quote currency used in totals.
data.total_pending_deposit_value	true	string	Total pending deposit value.
data.total_pending_withdraw_value	true	string	Total pending withdraw value.
data.total_available_value	true	string	Total available value.
data.total_value	true	string	Grand total value.
data.data[].currency	true	string	Balance currency.
data.data[].available	true	string	Available amount.
data.data[].pending_deposit	true	string	Pending deposit amount.
data.data[].pending_withdraw	true	string	Pending withdraw amount.
data.data[].total_balance	true	string	Total balance for the currency.
data.data[].total_value	true	string	Converted total value for the currency.

curl 'https://<host>/v1/balance?currency=NGN&timestamp=<TIMESTAMP>&recvWindow=5000&signature=<SIGNATURE>' \
  -H 'X-MBX-APIKEY: <ACCESS_ID>'

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
currency	false	string	Preferred quote currency; when omitted, the customer preference is used.
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.currency	true	string	Quote currency used in totals.
data.total_pending_deposit_value	true	string	Total pending deposit value.
data.total_pending_withdraw_value	true	string	Total pending withdraw value.
data.total_available_value	true	string	Total available value.
data.total_value	true	string	Grand total value.
data.data[].currency	true	string	Balance currency.
data.data[].available	true	string	Available amount.
data.data[].pending_deposit	true	string	Pending deposit amount.
data.data[].pending_withdraw	true	string	Pending withdraw amount.
data.data[].total_balance	true	string	Total balance for the currency.
data.data[].total_value	true	string	Converted total value for the currency.