Get Main Balance

GET

/balance

Retrieves the current balance of all cryptocurrencies in your main account. This endpoint provides a comprehensive overview of all your available funds, pending transactions, and their equivalent values in your configured base currency.

Example Request

GET /balance
X-API-Key: your_api_key_here

Response Parameters

Parameter	Type	Description
balances	object	Object containing balances for each cryptocurrency
total_usd_value	number	Total value of all balances in USD
updated_at	string	ISO 8601 timestamp of when the balances were last updated

Balance Object Structure

Each key in the balances object represents a cryptocurrency code. The value is an object with the following structure:

Parameter	Type	Description
amount	number	The available balance amount
pending_amount	number	The amount in pending transactions
usd_value	number	Equivalent value in USD
blockchain	string	The blockchain where this balance is held (e.g., ETH, BSC)

Example Response

{
  "balances": {
    "btc": {
      "amount": 0.15,
      "pending_amount": 0.05,
      "usd_value": 6075.00,
      "blockchain": "BTC"
    },
    "eth": {
      "amount": 5.25,
      "pending_amount": 0,
      "usd_value": 11550.00,
      "blockchain": "ETH"
    },
    "usdt": {
      "amount": 10000.00,
      "pending_amount": 2500.00,
      "usd_value": 10000.00,
      "blockchain": "TRX"
    },
    "usdterc20": {
      "amount": 5000.00,
      "pending_amount": 0,
      "usd_value": 5000.00,
      "blockchain": "ETH" 
    }
  },
  "total_usd_value": 32625.00,
  "updated_at": "2025-04-30T15:01:22.123Z"
}

Error Codes

Status Code	Error Code	Description
401	authentication_failed	Authentication failed. Check your API key or OAuth 2.0 access token
403	insufficient_permissions	Your API key does not have permission to view balances
429	rate_limit_exceeded	You have exceeded the rate limit for this endpoint
500	internal_error	An error occurred retrieving balance information

Notes

• Balance amounts are presented in their native cryptocurrency units (e.g., BTC, ETH).
• The pending_amount represents funds that are in active transactions (e.g., in-progress withdrawals).
• USD values are calculated based on current market rates and are for informational purposes only.
• Balances for the same token on different blockchains (e.g., USDT on Ethereum vs. Tron) are shown as separate entries.
• Only cryptocurrencies with non-zero total balances (available + pending) are included in the response.