# IG API GET /positions Independent and unofficial. Not affiliated with or endorsed by any broker or platform named here. Educational only: nothing here is advice, and nothing here recommends a broker or a trade. This is the markdown version of https://openbrokerapi.com/brokers/ig/endpoints/positions, written from the same records as that page. 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. All open positions on the active account, each with its market snapshot. - Request: `GET /positions` - Version: 2 - Group: Dealing - Status: verified. Source: [labs.ig.com](https://labs.ig.com/reference/positions.html), checked 2026-10-12. - Official reference: https://labs.ig.com/reference/positions.html Note: The method, path, version and parameters were re-read on IG's own reference page on 12 Oct 2026. That page lists no request headers: the headers recorded here are the general ones in IG's REST trading API guide (labs.ig.com/rest-trading-api-guide.html), read the same day. The mock reply is carried over from an earlier reading and was not compared field by field with the page. IG's own Java sample (RestAPI.java on GitHub, read the same day and marked deprecated) uses the same path. ## Parameters - `VERSION` (in header, type string, required): Endpoint version. Send 2. ### Authentication headers - `X-IG-API-KEY` (type string, required): Your API key, from your IG account settings. Placeholder only here. - `CST` (type string, required): Client session token returned by POST /session. - `X-SECURITY-TOKEN` (type string, required): Account security token returned by POST /session. ## Request Written from the method, path and parameters recorded on this page, against the demo host. 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 at https://openbrokerapi.com/tools/request-builder writes these same snippets, from the same record. ### Python ```python # Set IG_API_KEY, IG_CST, IG_SECURITY_TOKEN as environment variables first. Never paste real values into code. # IG_CST and IG_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /session returns: step 3 of the quickstart (/brokers/ig/quickstart#step-3) captures them and this sample reads them back. import os import requests BASE_URL = "https://demo-api.ig.com/gateway/deal" # the demo host headers = { "X-IG-API-KEY": os.environ["IG_API_KEY"], "CST": os.environ["IG_CST"], "X-SECURITY-TOKEN": os.environ["IG_SECURITY_TOKEN"], "VERSION": "2", } resp = requests.get(BASE_URL + "/positions", headers=headers, timeout=10) resp.raise_for_status() print(resp.json()) ``` ### JavaScript ```javascript // Set IG_API_KEY, IG_CST, IG_SECURITY_TOKEN as environment variables first. Never paste real values into code. // IG_CST and IG_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /session returns: step 3 of the quickstart (/brokers/ig/quickstart#step-3) captures them and this sample reads them back. // Run as a module, for example a .mjs file, on a Node version that has fetch built in. const BASE_URL = "https://demo-api.ig.com/gateway/deal"; // the demo host const res = await fetch(BASE_URL + "/positions", { method: "GET", headers: { "X-IG-API-KEY": process.env.IG_API_KEY, "CST": process.env.IG_CST, "X-SECURITY-TOKEN": process.env.IG_SECURITY_TOKEN, "VERSION": "2", }, }); if (!res.ok) throw new Error(`HTTP ${res.status}`); console.log(await res.json()); ``` ### curl ```bash # Set IG_API_KEY, IG_CST, IG_SECURITY_TOKEN as environment variables first. Never paste real values into code. # IG_CST and IG_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /session returns: step 3 of the quickstart (/brokers/ig/quickstart#step-3) captures them and this sample reads them back. curl -X GET "https://demo-api.ig.com/gateway/deal/positions" \ -H "X-IG-API-KEY: $IG_API_KEY" \ -H "CST: $IG_CST" \ -H "X-SECURITY-TOKEN: $IG_SECURITY_TOKEN" \ -H "VERSION: 2" ``` ## Response A mock response. The values are invented, so check field names against the [official reference](https://labs.ig.com/reference/positions.html). ```json { "_mock": true, "positions": [ { "position": { "dealId": "DIAAAAMOCK01", "direction": "BUY", "size": 1, "level": 7650.2, "currency": "GBP", "stopLevel": 7600, "limitLevel": null, "createdDateUTC": "2026-09-18T08:01:12" }, "market": { "epic": "IX.D.FTSE.DAILY.IP", "instrumentName": "FTSE 100 (mock)", "bid": 7655.1, "offer": 7656.1, "marketStatus": "TRADEABLE" } } ] } ``` ## Response schema, HTTP 200 Every field this site's OpenAPI file for IG (https://openbrokerapi.com/specs/ig.json) declares for this response. - `positions` (array of objects): One entry per open position on the active account. - `position` (object): The deal as opened, with its current stop and limit. - `contractSize` (number): Size of the contract - `createdDate` (string): Local date the position was opened - `createdDateUTC` (string): Date the position was opened - `dealId` (string): Deal identifier - `size` (number): Deal size - `direction` (string): Deal direction One of: BUY, SELL - `limitLevel` (number, nullable): Limit level - `level` (number): Level at which the position was opened - `currency` (string): Position currency ISO code - `controlledRisk` (boolean): True if position is risk controlled - `stopLevel` (number, nullable): Stop level - `trailingStep` (number, nullable): Trailing step size - `trailingStopDistance` (number, nullable): Trailing stop distance - `market` (object): A snapshot of the position's market when the call was answered. - `instrumentName` (string): Instrument name - `expiry` (string): Instrument expiry period - `epic` (string): Instrument epic identifier - `instrumentType` (string): Instrument type One of: BINARY, BUNGEE_CAPPED, BUNGEE_COMMODITIES, BUNGEE_CURRENCIES, BUNGEE_INDICES, COMMODITIES, CURRENCIES, INDICES, OPT_COMMODITIES, OPT_CURRENCIES, OPT_INDICES, OPT_RATES, OPT_SHARES, RATES, SECTORS, SHARES, SPRINT_MARKET, TEST_MARKET, UNKNOWN - `lotSize` (number): Instrument lot size - `high` (number): High price - `low` (number): Low price - `percentageChange` (number): Price percentage change - `netChange` (number): Price net change - `bid` (number): Bid - `offer` (number): Offer - `updateTime` (string): Local time of last instrument price update - `updateTimeUTC` (string): Time of last instrument price update - `delayTime` (integer): Instrument price delay (minutes) - `streamingPricesAvailable` (boolean): True if streaming prices are available, i.e. the market is tradeable and the client has appropriate permissions - `marketStatus` (string): Market status One of: CLOSED, EDITS_ONLY, OFFLINE, ON_AUCTION, ON_AUCTION_NO_EDITS, SUSPENDED, TRADEABLE - `scalingFactor` (integer): Multiplying factor to determine actual pip value for the levels used by the instrument Status: verified. Source: [github.com](https://github.com/IG-Group/ig-webapi-java-sample/tree/master/ig-webapi-java-client/src/main/java/com/iggroup/webapi/samples/client/rest/dto/positions/getPositionsV2), checked 2026-09-22. ## Limits that apply at IG - Historical price data points a week: 10,000 data points per week - Scope: Per account, price history endpoints only - Status: verified. Source: [labs.ig.com](https://labs.ig.com/faq.html), checked 2026-10-12. - Non trading requests a minute: 30 requests per minute - Scope: Per account, non trading calls only - Status: verified. Source: [labs.ig.com](https://labs.ig.com/faq.html), checked 2026-10-12. - Non trading requests a minute: 60 requests per minute - Scope: Per application, that is per API key, non trading calls only - Status: verified. Source: [labs.ig.com](https://labs.ig.com/faq.html), checked 2026-10-12. - Concurrent streaming subscriptions: 40 subscriptions - Scope: Per streaming connection - Status: verified. Source: [labs.ig.com](https://labs.ig.com/faq.html), checked 2026-10-12. - Corroborated by [labs.ig.com/streaming-api-guide.html](https://labs.ig.com/streaming-api-guide.html) - Trading requests a minute: 100 requests per minute - Scope: Per account, trading calls only - Sources conflict: [ig.com](https://www.ig.com/en/trading-platforms/trading-apis/how-to-use-ig-api) states around 40 trade requests per minute, checked 2026-10-05. IG's own pages disagree. The conflict is labelled, not resolved. Pace against 40. - Status: conflicting. Source: [labs.ig.com](https://labs.ig.com/faq.html), checked 2026-10-12. ## More on the IG API - [All IG API endpoints](https://openbrokerapi.com/brokers/ig/endpoints): 49 documented, grouped by what they do. - [IG API quickstart](https://openbrokerapi.com/brokers/ig/quickstart) - [All IG API error codes](https://openbrokerapi.com/errors/ig) - [IG API page](https://openbrokerapi.com/brokers/ig): The full record: access, authentication, limits and the source for each. - [IG API as an OpenAPI file](https://openbrokerapi.com/specs/ig.json): Generated from these endpoint records. Independent and unofficial. ## Licence and how to cite The records behind this page are all rights reserved. This file is the page itself, at its own address, in another format. It is not part of the CC BY 4.0 downloads listed at https://openbrokerapi.com/data. Quote from it with a link to the page. Cite as: IG API GET /positions. Broker API Hub, https://openbrokerapi.com/brokers/ig/endpoints/positions, newest check 2026-10-12. Where you rely on a single figure, cite the source and the checked date printed beside it as well. Where this page and a broker's own documentation differ, the documentation wins.