Balance

This endpoint retrieves the current cash position and asset balance for the authenticated user across all supported currencies. It is commonly used to display portfolio summaries, verify available funds before trading, or for backend reconciliation.

---

HTTP Request

GET /account/v1/balance

Request Parameters

None.

---

✅ Successful Response

Returns a list of balance summaries per base currency, including available cash, unsettled funds, and interest details.

Response Fields

Field	Type	Description
base_currency	string	Currency code (e.g., USD, HKD, USDT)
market_value	decimal	Total market value of the assets
cash	decimal	Total cash value. this field is deprecated. Please use cash_on_hold instead.
cash_on_hold	decimal	Total cash value
cash_withdraw	decimal	Cash available for withdrawal
unsett_net_amt	decimal	Net unsettled amount (e.g., frozen withdrawal + buy fees + sell fees)
unsett_buy_amt	decimal	Amount frozen for unsettled buy orders
unsett_sell_amt	decimal	Amount frozen for unsettled sell orders
interest_net	decimal	Net interest (earned – owed)
interest_debit	decimal	Interest owed
interest_credit	decimal	Interest earned

❌ Error Response

Error Fields

Field	Type	Description
code	int	Error code
message	string	Human-readable error message
details	string	Additional error information

💡 cURL Example

curl -X GET "https://{{base_url}}/account/v1/balance" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Timestamp: 1746777861334" \
  -H "X-API-Signature: YOUR_GENERATED_SIGNATURE" \
  -H "Content-Type: application/json"

---

✅ Sample Success Response

{
  "code": 0,
  "data": [
    {
      "base_currency": "USD",
      "market_value": 12500.50,
      "cash": 10000.00,
      "cash_on_hold": 1500.00,
      "cash_withdraw": 8500.00,
      "unsett_net_amt": 1000.00,
      "unsett_buy_amt": 600.00,
      "unsett_sell_amt": 400.00,
      "interest_net": 25.00,
      "interest_credit": 30.00,
      "interest_debit": 5.00
    }
  ]
}

---

❌ Sample Error Response

{
  "code": 12010012,
  "message": "Internal server error"
}