View Cash Balances

POST

/gw/api/v1/external-cash-transfers/query

POST

/gw/api/v1/external-cash-transfers/query

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

1 {
2   "instructionResult": {
3     "accountId": "U46377",
4     "allowedTransferAmountToMaster": 0,
5     "allowedTransferAmountToMasterNoBorrow": 0,
6     "clientInstructionId": 7013230,
7     "currency": "EUR",
8     "ibReferenceId": 0,
9     "instructionId": 43133309,
10     "instructionStatus": "PROCESSED",
11     "instructionType": "QUERY_WITHDRAWABLE_FUNDS",
12     "withdrawableAmount": 0,
13     "withdrawableAmountNoBorrow": 0
14   },
15   "instructionSetId": 17791,
16   "status": 201
17 }

View available cash for withdrawal with and without margin loan by accountId

Scope: transfers.read
Security Policy: Signed JWT

Path parameters

client-idstringRequired

The client's clientId

Request

Create an external cash transfer query request body

instructionTypeenumRequired

Allowed values:

instructionobjectRequired

Response

Instruction successfully created and processed synchronously

QueryWithdrawableAmountsResponseobject

QueryWithdrawableAmountsWithoutOriginHoldResponseobject

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error