Get Blockchain Balance

Get a summary of balances for a specific blockchain, including hot wallet, cold wallet, and custody balances.

Endpoint

GET /manage/users/balances/{blockchain}

Authentication

This endpoint requires an OAuth 2.0 access token with tenant administrator or global administrator role:

Authorization: Bearer {access_token}

Parameters

Path Parameters

Parameter	Type	Description
blockchain	string	Required. The blockchain to get balances for (e.g., "ETH", "BSC", "TRX", "SOL")

Query Parameters

Parameter	Type	Default	Description
token	string	"USDT"	The token to filter by

Response

200 OK

A successful response will include a summary of balances for the specified blockchain:

{
  "blockchain": "ETH",
  "token": "USDT",
  "hot_wallet_balance": 1000.0,
  "cold_wallet_balance": 5000.0,
  "custody_balance": 2000.0,
  "total_balance": 8000.0
}

Response Fields

Field	Type	Description
blockchain	string	Blockchain identifier (e.g., "ETH", "BSC")
token	string	Token symbol (e.g., "USDT")
hot_wallet_balance	number	Total balance in hot wallets
cold_wallet_balance	number	Total balance in cold wallets
custody_balance	number	Total balance in custody accounts
total_balance	number	Sum of all balances

400 Bad Request

Occurs when an invalid blockchain is specified:

{
  "detail": "Invalid blockchain: XYZ"
}

401 Unauthorized

Occurs when the OAuth 2.0 access token is missing or invalid:

{
  "detail": "Not authenticated"
}

403 Forbidden

Occurs when the authenticated user doesn't have tenant administrator role:

{
  "detail": "Only tenant administrators can access this endpoint"
}

Example Requests

Get ETH Balances

curl -X GET "{{BASE_URL}}/manage/users/balances/ETH" \
  -H "Authorization: Bearer eyJ0eXAiOiJPQXV0aFRva2VuIiwiYWxnIjoiUlMyNTYifQ..."

Get BSC Balances with Custom Token

curl -X GET "{{BASE_URL}}/manage/users/balances/BSC?token=BUSD" \
  -H "Authorization: Bearer eyJ0eXAiOiJPQXV0aFRva2VuIiwiYWxnIjoiUlMyNTYifQ..."

Example Response

{
  "blockchain": "ETH",
  "token": "USDT",
  "hot_wallet_balance": 1000.0,
  "cold_wallet_balance": 5000.0,
  "custody_balance": 2000.0,
  "total_balance": 8000.0
}

Usage Notes

1. Use this endpoint to quickly check the total available balance for a specific blockchain, which is useful when planning withdrawals.

2. The total balance is the sum of hot wallet, cold wallet, and custody balances.

3. For withdrawal availability, consider only hot wallet and custody balances, as cold wallet funds require offline signing and are not immediately available.

4. The default token is USDT, but you can specify a different token using the token query parameter.

5. This endpoint returns aggregated balances only. For detailed wallet information, use the /manage/users/balances endpoint.