Interactive Brokers API GET /portfolio/{accountId}/ledger
Cash balance, net liquidation and profit and loss for each currency the account holds, plus a BASE total.
Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.
Keys are currency codes such as USD, plus BASE for the account's base currency.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| accountIdrequired | path | string | Your IBKR account ID. The code reads it from the IBKR_ACCOUNT_ID environment variable. Never type it into this site. |
Authentication headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | OAuth only; the Gateway sends none. On the OAuth host this is the SSO bearer token IBKR's reference lists for this call. With the Client Portal Gateway on your own computer the browser login holds the session. Placeholder only. |
Request
Written from the method, path and parameters recorded on this page. No demo host is recorded as a plain address for this API, so the samples read the base address from an environment variable. Not executed against a live or demo account. Credentials are read from environment variables on your own machine and are never entered on this site. The request builder writes these same snippets, from the same record.
Python
# Set IBKR_BASE_URL, IBKR_ACCOUNT_ID as environment variables first. Never paste real values into code.
# No demo host is recorded as a plain address for this API, so the base address is read from IBKR_BASE_URL.
# Optional and not shown: headers Authorization.
import os
import requests
BASE_URL = os.environ["IBKR_BASE_URL"]
headers = {}
resp = requests.get(BASE_URL + "/portfolio/" + os.environ["IBKR_ACCOUNT_ID"] + "/ledger", headers=headers, timeout=10)
resp.raise_for_status()
print(resp.json())JavaScript
// Set IBKR_BASE_URL, IBKR_ACCOUNT_ID as environment variables first. Never paste real values into code.
// No demo host is recorded as a plain address for this API, so the base address is read from IBKR_BASE_URL.
// Optional and not shown: headers Authorization.
// Run as a module, for example a .mjs file, on a Node version that has fetch built in.
const BASE_URL = process.env.IBKR_BASE_URL;
const res = await fetch(BASE_URL + "/portfolio/" + process.env.IBKR_ACCOUNT_ID + "/ledger", {
method: "GET",
headers: {
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());curl
# Set IBKR_BASE_URL, IBKR_ACCOUNT_ID as environment variables first. Never paste real values into code. # No demo host is recorded as a plain address for this API, so the base address is read from IBKR_BASE_URL. # Optional and not shown: headers Authorization. curl -X GET "$IBKR_BASE_URL/portfolio/$IBKR_ACCOUNT_ID/ledger"
Response
A mock response. The values are invented, so check field names against the official reference.
{
"_mock": true,
"BASE": {
"cashbalance": 7500,
"netliquidationvalue": 10000,
"unrealizedpnl": 120.5,
"realizedpnl": 0,
"stockmarketvalue": 2500,
"exchangerate": 1,
"timestamp": 1789725600
},
"USD": {
"cashbalance": 0,
"netliquidationvalue": 3200,
"unrealizedpnl": 160,
"realizedpnl": 0,
"stockmarketvalue": 3200,
"exchangerate": 0.78,
"timestamp": 1789725600
}
}Limits that apply at Interactive Brokers
| Limit | Value | Scope | Source |
|---|---|---|---|
| Global requests a second (Web API) | 10 | Per authenticated username, that is per Web API session | ibkrcampus.comchecked corroborated by interactivebrokers.com/docs/web-api/trading/usage-and-availability/pacing-limitations |
| Historical market data requests | Either 10 req/s or 50 req/minute, as the page words it | GET /iserver/marketdata/history only | interactivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/ |
| Market data snapshot requests a second | 10 | GET /iserver/marketdata/snapshot only | interactivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/ |
| Order and trade list requests | 1 req/5 s | GET /iserver/orders and GET /iserver/trades, each counted on its own | interactivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/ |
| Session validation requests a minute | 1 | GET /sso/validate only | interactivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/ |
| Session keep alive requests a second | 1 | GET /tickle only | interactivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/ |
Interactive Brokers API errors you may meet
- 0 (internal server error)Listed by the vendor as "Internal server error".
- 100 (max message rate exceeded)Max rate of messages per second has been exceeded.
- 10000 (cross currency combo)Listed by the vendor as "Cross currency combo error".
- 10001 (cross currency vol)Listed by the vendor as "Cross currency vol error".
- 10002 (non guaranteed legs)Listed by the vendor as "Invalid non-guaranteed legs".
- 10003 (ibsx not allowed)Listed by the vendor as "IBSX not allowed".
All Interactive Brokers API error codes, including 505 more not listed here.