Balance Endpoints¶

This section covers API endpoints related to account balances.

Get All Balances¶

Returns the balance information for all currencies in your account.

GET /balance

Required Permissions¶

allow_balance

Rate Limit¶

30 requests per minute

Response¶

A list of balance objects, one for each currency:

[
  {
    "currency": "BTC",
    "available": "0.05000000",
    "frozen": "0.00000000",
    "updated_at": "2023-01-15T14:30:15Z"
  },
  {
    "currency": "ETH",
    "available": "1.25000000",
    "frozen": "0.50000000",
    "updated_at": "2023-01-15T14:30:15Z"
  }
]

Response Fields¶

Field	Type	Description
`currency`	string	Currency code
`available`	string	Available balance that can be used for operations
`frozen`	string	Balance that is temporarily frozen (e.g., in pending operations)
`updated_at`	string	Last time the balance was updated (ISO 8601 format)

Notes¶

Balances are returned for all currencies, including those with zero balance
The available and frozen fields are strings to preserve precision for decimal values

Usage Example¶

Request¶

GET /api/v1/balance
X-Access-Key: your_access_key
X-Timestamp: 1676541877000
X-Signature: calculated_signature

Response¶

[
  {
    "currency": "BTC",
    "available": "0.05000000",
    "frozen": "0.00000000",
    "updated_at": "2023-01-15T14:30:15Z"
  },
  {
    "currency": "ETH",
    "available": "1.25000000",
    "frozen": "0.50000000",
    "updated_at": "2023-01-15T14:30:15Z"
  },
  {
    "currency": "USDT",
    "available": "1000.00000000",
    "frozen": "250.00000000",
    "updated_at": "2023-01-15T14:30:15Z"
  }
]

Common Use Cases¶

Check available funds: Before initiating operations like withdrawals or swaps
Monitor account activity: Track changes in balances over time
Reconcile transactions: Verify that operations have correctly affected your balances