Balances
GET
/balances
Account balances
Parameters
Header Parameters
X-API-KEY*
Type
Requiredstring
Query Parameters
account_number*
Type
Requiredstring
end_customer_id
Optional end-customer identifier for retrieving balances scoped to a single end-customer account under the omnibus account.
Type
string
include_adjustments
Pass true to include cash or margin adjustment in the response.
Type
boolean
include_all_custodians
Aggregates balances across all the clearing firms the broker has accounts at.
Type
boolean
Responses
OK
application/json
JSON "cash_available": "1.23", "cash_secured": "1.23", "cash_withheld_for_buys": "1.23", "cash_withheld_for_exercise": "1.23", "adjustment": "1.23"
{
}