Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Balances

Retrieve Balance

Retrieves the current account balance, based on the authentication that was used to make the request.

get/v1/balances/{currency}

Path parameters

currencystring required
Example:USD

Specifies the currency for which the balance is retrieved. Only a single currency can be provided. Currency codes follow the ISO 4217 standard.

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Response

Balances returned successfully.

balance_idstring required

The account balance id.

currencystring required

Currency of the account balance.

available_balancestring number required

Available balance.

prepaid_balancestring number required

Prepaid account balance.

margin_balancestring number required

Margin balance.

frozen_balancestring number required

Frozen balance.

create_timestring date/time required

The timestamp when the record was created in the system. Timestamp follows the ISO 8601 standard.

last_trade_timestring required

The last trade time at which the object was updated.

balance_status'ACTIVE' | 'PENDING' | 'PROCESSING' | 'CLOSED' required

The balance status of the account.

  • ACTIVE: Account balance is operational and available for transactions.
  • PENDING: Account balance is awaiting activation or verification.
  • PROCESSING: Account balance is currently being updated or modified.
  • CLOSED: Account balance has been terminated and is no longer accessible.

Example response

{
  "balance_id": "72970a7c-7921-431c-b95f-3438724ba16f",
  "currency": "USD",
  "available_balance": "5000.25",
  "prepaid_balance": "3600.12",
  "margin_balance": "10000.00",
  "frozen_balance": "2353.25",
  "create_time": "2024-03-01T00:00:00+08:00",
  "last_trade_time": "2024-03-21T17:17:32+08:00",
  "balance_status": "ACTIVE"
}