Broker API HubMenu

Interactive Brokers API GET /iserver/marketdata/snapshot

GET/iserver/marketdata/snapshotversion v1Market data

Top of book values for one or more contracts, such as last (31), bid (84) and ask (86). The first request only starts the data.

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.

Independent and unofficialibkrcampus.comchecked

IBKR: a pre-flight request must be made before any data comes back, /iserver/accounts must be called first, and for derivatives /iserver/secdef/search first. The lesson shows the first reply carrying only _updated, conidEx and conid; the numbered keys in our mock follow the fields you asked for.

Parameters

NameInTypeDescription
conidsrequiredquerystringContract IDs, comma separated.
fieldsquerystringTick IDs, comma separated, 50 at most. 31 last price, 55 symbol, 84 bid, 86 ask, 70 high, 71 low, 7295 open.

Authentication headers

NameTypeDescription
AuthorizationstringOAuth 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 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.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: headers Authorization; query parameters fields.
import os
import requests

BASE_URL = os.environ["IBKR_BASE_URL"]
headers = {}
params = {"conids": "{conids}"}
resp = requests.get(BASE_URL + "/iserver/marketdata/snapshot", headers=headers, params=params, 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.
// Replace each {placeholder}, "..." and 0 with a real value before running.
// Optional and not shown: headers Authorization; query parameters fields.
// 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/marketdata/snapshot" + "?conids={conids}", {
  method: "GET",
  headers: {
  },
});
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.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: headers Authorization; query parameters fields.
curl -X GET "$IBKR_BASE_URL/iserver/marketdata/snapshot?conids={conids}"

Response

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

[
  {
    "31": "190.00",
    "84": "189.99",
    "86": "190.01",
    "_mock": true,
    "_updated": 1789725600000,
    "conidEx": "265598",
    "conid": 265598
  }
]

Response schema, HTTP 200

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

FieldTypeDescription
conidintegerNot recorded
conidExstringNot recorded
_updatedintegerNot recorded

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

LimitValueScopeSource
Global requests a second (Web API)10Per authenticated username, that is per Web API sessionibkrcampus.comchecked corroborated by interactivebrokers.com/docs/web-api/trading/usage-and-availability/pacing-limitations
Historical market data requestsEither 10 req/s or 50 req/minute, as the page words itGET /iserver/marketdata/history onlyinteractivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/
Market data snapshot requests a second10GET /iserver/marketdata/snapshot onlyinteractivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/
Order and trade list requests1 req/5 sGET /iserver/orders and GET /iserver/trades, each counted on its owninteractivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/
Session validation requests a minute1GET /sso/validate onlyinteractivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/
Session keep alive requests a second1GET /tickle onlyinteractivebrokers.comchecked corroborated by ibkrcampus.com/campus/ibkr-api-page/webapi-doc/

Interactive Brokers API errors you may meet

All Interactive Brokers API error codes, including 505 more not listed here.