Interactive Brokers API GET /portfolio/accounts

Parameters

No parameters recorded beyond authentication.

Authentication headers

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.

# Set IBKR_BASE_URL as an environment variable 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/accounts", headers=headers, timeout=10)
resp.raise_for_status()
print(resp.json())

// Set IBKR_BASE_URL as an environment variable 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/accounts", {
  method: "GET",
  headers: {
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

# Set IBKR_BASE_URL as an environment variable 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/accounts"

Response

A mock response. The values are invented, so check field names against the official reference.

[
  {
    "_mock": true,
    "id": "MOCK-ACCOUNT-001",
    "accountId": "MOCK-ACCOUNT-001",
    "accountVan": "MOCK-ACCOUNT-001",
    "accountTitle": "Mock Account",
    "displayName": "MOCK-ACCOUNT-001",
    "accountAlias": null,
    "currency": "GBP",
    "type": "DEMO",
    "tradingType": "STKNOPT",
    "faclient": false,
    "covestor": false,
    "brokerageAccess": true,
    "noClientTrading": false
  }
]

Response schema, HTTP 200

Every field this site's OpenAPI file for Interactive Brokers declares for this response.

Unverifiedno source opened This schema is not sourced to a page of the provider's own that we opened, so check field names against the official reference.

Limits that apply at Interactive Brokers

Related Interactive Brokers API endpoints: Accounts

• GET/iserver/account/pnl/partitionedUpdated profit and loss for the selected account, keyed by account and segment. The first request returns an empty upnl object.
• GET/iserver/accountsThe accounts you can trade, their aliases and the currently selected account. IBKR says to call it before the market data snapshot.
• GET/portfolio/{accountId}/ledgerCash balance, net liquidation and profit and loss for each currency the account holds, plus a BASE total.
• GET/portfolio/{accountId}/positions/{pageId}All positions in an account, one page at a time, with size, market price, market value and unrealised profit and loss.
• GET/portfolio/{accountId}/summaryAccount values such as net liquidation, available funds, buying power and margin, by segment where it applies.

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.