Broker API HubMenu

IG API GET /positions

GET/positionsversion 2Dealing

All open positions on the active account, each with its market snapshot.

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 unofficiallabs.ig.comchecked

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

NameInTypeDescription
VERSIONrequiredheaderstringEndpoint version. Send 2.

Authentication headers

NameTypeDescription
X-IG-API-KEYrequiredstringYour API key, from your IG account settings. Placeholder only here.
CSTrequiredstringClient session token returned by POST /session.
X-SECURITY-TOKENrequiredstringAccount 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 writes these same snippets, from the same record.

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
// 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
# 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.

{
  "_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 declares for this response.

FieldTypeDescription
positionsarray of objectsOne entry per open position on the active account.
positionobjectThe deal as opened, with its current stop and limit.
contractSizenumberSize of the contract
createdDatestringLocal date the position was opened
createdDateUTCstringDate the position was opened
dealIdstringDeal identifier
sizenumberDeal size
directionstringDeal directionOne of: BUY, SELL
limitLevelnumber, nullableLimit level
levelnumberLevel at which the position was opened
currencystringPosition currency ISO code
controlledRiskbooleanTrue if position is risk controlled
stopLevelnumber, nullableStop level
trailingStepnumber, nullableTrailing step size
trailingStopDistancenumber, nullableTrailing stop distance
marketobjectA snapshot of the position's market when the call was answered.
instrumentNamestringInstrument name
expirystringInstrument expiry period
epicstringInstrument epic identifier
instrumentTypestringInstrument typeOne 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
lotSizenumberInstrument lot size
highnumberHigh price
lownumberLow price
percentageChangenumberPrice percentage change
netChangenumberPrice net change
bidnumberBid
offernumberOffer
updateTimestringLocal time of last instrument price update
updateTimeUTCstringTime of last instrument price update
delayTimeintegerInstrument price delay (minutes)
streamingPricesAvailablebooleanTrue if streaming prices are available, i.e. the market is tradeable and the client has appropriate permissions
marketStatusstringMarket statusOne of: CLOSED, EDITS_ONLY, OFFLINE, ON_AUCTION, ON_AUCTION_NO_EDITS, SUSPENDED, TRADEABLE
scalingFactorintegerMultiplying factor to determine actual pip value for the levels used by the instrument

github.comchecked

Limits that apply at IG

LimitValueScopeSource
Historical price data points a week10,000Per account, price history endpoints onlylabs.ig.comchecked
Non trading requests a minute30Per account, non trading calls onlylabs.ig.comchecked
Non trading requests a minute60Per application, that is per API key, non trading calls onlylabs.ig.comchecked
Concurrent streaming subscriptions40Per streaming connectionlabs.ig.comchecked corroborated by labs.ig.com/streaming-api-guide.html
Trading requests a minute100Sources conflict ig.com states around 40, checked . IG's own pages disagree. The conflict is labelled, not resolved. Pace against 40.Per account, trading calls onlylabs.ig.comchecked

IG API errors you may meet

All IG API error codes, including 126 more not listed here.