Beta Ramps API
Balances

Get Balances

GET
/balances

Authorization

headerAuthorizationBearer <token>

Scope: balances:read

Query Parameters

asset?string

Asset code (exact match, e.g. BRL, USDT). Alone: per-subaccount breakdown of that asset. With subaccount_id: that subaccount's balance in the asset.

subaccount_id?string

Subaccount ID (sub_…). Alone: all asset balances of that subaccount. A subaccount not owned by your account returns 403 subaccount_not_found / "Subaccount not found".

Response Body

Balances. The response shape depends on which query parameters are set (neither, subaccount_id, asset, or both). All amounts are decimal strings.

application/json
  1. response

Returned when neither asset nor subaccount_id is set.

account_id*string

Account ID (acc_…).

balances*array<>
Example Request
curl -X GET 'https://api.betaramps.com/balances'
Example Response
{  "account_id": "acc_0192f4e0-1a2b-7c3d-8e4f-5a6b7c8d9e01",  "balances": [    {      "asset": "BRL",      "pool": {        "current_balance": "10000",        "pending_balance": "0",        "available_balance": "10000"      },      "subaccounts": {        "current_balance": "2500.75",        "pending_balance": "500",        "available_balance": "2000.75",        "subaccount_count": 2      },      "total": {        "current_balance": "12500.75",        "pending_balance": "500",        "available_balance": "12000.75"      }    },    {      "asset": "USDT",      "pool": {        "current_balance": "1500.25",        "pending_balance": "0",        "available_balance": "1500.25"      },      "subaccounts": {        "current_balance": "300",        "pending_balance": "0",        "available_balance": "300",        "subaccount_count": 1      },      "total": {        "current_balance": "1800.25",        "pending_balance": "0",        "available_balance": "1800.25"      }    }  ]}