Broker API HubMenu

IG API PUT /working-orders/otc/{dealId}

PUT/working-orders/otc/{dealId}version 2Dealing

Amend an OTC working order that has not filled: its level, type, stop, limit and expiry. Returns a dealReference to confirm, as dealing calls do.

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 unofficialSources conflictlabs.ig.comchecked

The method, path, version, parameters and response fields were 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. IG's reference page prints this path with a hyphen. IG's own Java sample (RestAPI.java on GitHub, read the same day and marked deprecated since 2024) calls workingorders/otc/{dealId} without one. The two disagree and neither was tested against a host here, so the record is marked conflicting. Versions 1 and 2 list the same body fields.

Parameters

NameInTypeDescription
VERSIONrequiredheaderstringEndpoint version. Send 2.
dealIdrequiredpathstringDeal identifier of the working order.
levelrequiredbodynumberThe order level. The only field the page marks as not null.
typebodystringLIMIT or STOP.
timeInForcebodystringGOOD_TILL_CANCELLED or GOOD_TILL_DATE.
goodTillDatebodystringExpiry for GOOD_TILL_DATE: yyyy/mm/dd hh:mm:ss in UTC, or a Unix timestamp in milliseconds.
guaranteedStopbodybooleanTrue for a guaranteed stop.
stopLevelbodynumberStop as a price level.
stopDistancebodynumberStop as a distance.
limitLevelbodynumberLimit as a price level.
limitDistancebodynumberLimit as a distance.

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.

This call takes a request body. The samples send it as JSON with a Content-Type of application/json (in Python, passing json= sets that header) and a placeholder for each of the 1 body field the record marks as required. Each placeholder has to be replaced with a real value before the request can succeed.

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.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: body fields type, timeInForce, goodTillDate, guaranteedStop, stopLevel, stopDistance, limitLevel, limitDistance.
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",
}
body = {"level": 0}
resp = requests.put(BASE_URL + "/working-orders/otc/{dealId}", headers=headers, json=body, 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.
// Replace each {placeholder}, "..." and 0 with a real value before running.
// Optional and not shown: body fields type, timeInForce, goodTillDate, guaranteedStop, stopLevel, stopDistance, limitLevel, limitDistance.
// 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 + "/working-orders/otc/{dealId}", {
  method: "PUT",
  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",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"level": 0}),
});
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.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: body fields type, timeInForce, goodTillDate, guaranteedStop, stopLevel, stopDistance, limitLevel, limitDistance.
curl -X PUT "https://demo-api.ig.com/gateway/deal/working-orders/otc/{dealId}" \
  -H "X-IG-API-KEY: $IG_API_KEY" \
  -H "CST: $IG_CST" \
  -H "X-SECURITY-TOKEN: $IG_SECURITY_TOKEN" \
  -H "VERSION: 2" \
  -H "Content-Type: application/json" \
  -d '{"level": 0}'

Response

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

{
  "_mock": true,
  "dealReference": "MOCKREF0002"
}

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.