Interactive Brokers API POST /iserver/auth/ssodh/init
Starts the brokerage session. IBKR documents it for OAuth users after the access token and live session token steps.
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.
compete true disconnects your other brokerage sessions to prioritise this one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| publish | body | boolean | Publish the brokerage session token at the same time. IBKR says setting true is the preferred way. |
| compete | body | boolean | Whether other brokerage sessions should be disconnected to prioritise this connection. |
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.
This call takes a request body. The record marks no body field as required, so the samples send an empty JSON object with a Content-Type of application/json (in Python, passing json= sets that header). Add the fields the call needs from the parameters above before the request can succeed.
Python
# 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; body fields publish, compete.
import os
import requests
BASE_URL = os.environ["IBKR_BASE_URL"]
headers = {}
body = {}
resp = requests.post(BASE_URL + "/iserver/auth/ssodh/init", headers=headers, json=body, timeout=10)
resp.raise_for_status()
print(resp.json())JavaScript
// 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; body fields publish, compete.
// 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 + "/iserver/auth/ssodh/init", {
method: "POST",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());curl
# 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; body fields publish, compete.
curl -X POST "$IBKR_BASE_URL/iserver/auth/ssodh/init" \
-H "Content-Type: application/json" \
-d '{}'Response
A mock response. The values are invented, so check field names against the official reference.
{
"_mock": true,
"authenticated": true,
"established": true,
"competing": false,
"connected": true,
"message": "",
"MAC": "00:00:00:00:00:00",
"serverInfo": {
"serverName": "MOCK-SERVER",
"serverVersion": "MOCK-BUILD"
},
"fail": ""
}Response schema, HTTP 200
Every field this site's OpenAPI file for Interactive Brokers declares for this response.
| Field | Type | Description |
|---|---|---|
| authenticated | boolean | Whether the brokerage session is authenticated. |
| established | boolean | Whether the brokerage session is fully established and ready to handle requests. |
| competing | boolean | Whether a competing brokerage session exists in another connection. |
| connected | boolean | Whether you are connected to the gateway. |
| message | string | Not recorded |
| MAC | string | Not recorded |
| serverInfo | object | Not recorded |
| serverName | string | Not recorded |
| serverVersion | string | Not recorded |
| hardware_info | string | Client Portal use only. |
| fail | string | Reason for failing to retrieve authentication status. |
interactivebrokers.comchecked
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.