View Cash Balances

POST

/gw/api/v1/balances/query

POST

/gw/api/v1/balances/query

$ curl -X POST https://api.ibkr.com/gw/api/v1/balances/query \
>      -H "Content-Type: application/json" \
>      -d '{
>   "instructionType": "QUERY_WITHDRAWABLE_CASH_EQUITY",
>   "instruction": {
>     "accountId": "U87440",
>     "clientInstructionId": 7009005,
>     "currency": "USD"
>   }
> }'

1 {
2   "instructionResult": {
3     "accountId": "U46377",
4     "availableEquityValue": 121538.65,
5     "clientInstructionId": 7013230,
6     "currency": "USD",
7     "ibReferenceId": 0,
8     "instructionId": 43133309,
9     "instructionStatus": "PROCESSED",
10     "instructionType": "QUERY_WITHDRAWABLE_CASH_EQUITY",
11     "withdrawableCashAmount": 250000
12   },
13   "instructionSetId": 17791,
14   "status": 201
15 }

View available cash for withdrawal and account equity value by accountId

Scope: balances.read
Security Policy: Signed JWT

Path parameters

client-idstringRequired

The client's clientId

Request

Create an query request body

instructionTypeenumRequired

Allowed values:

instructionobjectRequired

Response

Instruction successfully created and processed synchronously

QueryWithdrawableCashEquityResponseobject

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error