Endpoints
Balance object
User-scoped list (JWT-oriented)
GET /v1/balances/{account_id} instead.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Account equity, margin, and session snapshots.
balances.updated on the Realtime WebSocket. The REST endpoints below are for hydration and point-in-time reads.| Method | Path | Page |
|---|---|---|
GET | /v1/balances/{account_id} | Get balance |
GET | /v1/balances/{account_id}/snapshots | List snapshots |
GET | /v1/balances/{account_id}/snapshots/{date} | Get snapshot by date |
GET | /v1/balances?user_id={uuid} | List balances for a user (JWT) |
POST | /v1/balances/{account_id}/adjust | Adjust cash (firm) |
GET | /v1/balances/{account_id}/adjustments | List adjustments (firm) |
{
"account_id": "5b1c...",
"currency": "USD",
"cash_balance": "50000.00",
"equity": "50250.50",
"unrealized_pnl": "250.50",
"realized_pnl_today": "125.00",
"margin_used": "4400.00",
"margin_available": "45850.50",
"updated_at": 1750000000200
}
| Field | Notes |
|---|---|
cash_balance | Settled cash. |
equity | cash_balance + unrealized_pnl. |
realized_pnl_today | Realized P&L for the current GLOBEX session. |
margin_used | Initial margin held against open positions. |
margin_available | equity - margin_used. |
GET /v1/balances?user_id={uuid}
GET /v1/balances/{account_id} instead.