Capital.com API POST /api/v1/workingorders

POST/api/v1/workingordersversion v1Working orders

Create a LIMIT or STOP order at a price level, optionally with a cancellation date, stop loss and take profit.

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 unofficialopen-api.capital.comchecked 12 Oct 2026

Confirmed on the official reference. Limit: 1 request per 0.1 seconds for orders, and 1000 an hour on demo. Method, path and request parameters were re-read on open-api.capital.com on 12 Oct 2026 and agree with this record; the mock reply was not compared field by field.

Parameters

Name	In	Type	Description
directionrequired	body	string	BUY or SELL.
epicrequired	body	string	Instrument epic, for example from GET /api/v1/markets.
sizerequired	body	number	Deal size.
levelrequired	body	number	Order price.
typerequired	body	string	LIMIT or STOP.
goodTillDate	body	string	Cancellation date in UTC, format YYYY-MM-DDTHH:MM:SS. Leave out for good till cancelled.
guaranteedStop	body	boolean	True for a guaranteed stop. Then set stopLevel, stopDistance or stopAmount. Not allowed with trailingStop or in hedging mode.
trailingStop	body	boolean	True for a trailing stop. Then set stopDistance. Not allowed with guaranteedStop.
stopLevel	body	number	Price at which the stop loss triggers.
stopDistance	body	number	Distance from the current price to the stop loss. Required when trailingStop is true.
stopAmount	body	number	Loss amount at which the stop loss triggers.
profitLevel	body	number	Price at which the take profit triggers.
profitDistance	body	number	Distance from the current price to the take profit.
profitAmount	body	number	Profit amount at which the take profit triggers.

Authentication headers

Name	Type	Description
CSTrequired	string	Access token returned in the CST response header of POST /session. Valid for 10 minutes after last use. Placeholder only.
X-SECURITY-TOKENrequired	string	Account token returned in the X-SECURITY-TOKEN response header of POST /session. It selects the financial account. Placeholder only.

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 5 body fields the record marks as required. Each placeholder has to be replaced with a real value before the request can succeed.

Python

# Set CAPITAL_CST, CAPITAL_SECURITY_TOKEN as environment variables first. Never paste real values into code.
# CAPITAL_CST and CAPITAL_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /api/v1/session returns: step 3 of the quickstart (/brokers/capital-com/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 goodTillDate, guaranteedStop, trailingStop, stopLevel, stopDistance, stopAmount, profitLevel, profitDistance, profitAmount.
import os
import requests

BASE_URL = "https://demo-api-capital.backend-capital.com"  # the demo host
headers = {
    "CST": os.environ["CAPITAL_CST"],
    "X-SECURITY-TOKEN": os.environ["CAPITAL_SECURITY_TOKEN"],
}
body = {"direction": "...", "epic": "...", "size": 0, "level": 0, "type": "..."}
resp = requests.post(BASE_URL + "/api/v1/workingorders", headers=headers, json=body, timeout=10)
resp.raise_for_status()
print(resp.json())

JavaScript

// Set CAPITAL_CST, CAPITAL_SECURITY_TOKEN as environment variables first. Never paste real values into code.
// CAPITAL_CST and CAPITAL_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /api/v1/session returns: step 3 of the quickstart (/brokers/capital-com/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 goodTillDate, guaranteedStop, trailingStop, stopLevel, stopDistance, stopAmount, profitLevel, profitDistance, profitAmount.
// Run as a module, for example a .mjs file, on a Node version that has fetch built in.
const BASE_URL = "https://demo-api-capital.backend-capital.com"; // the demo host
const res = await fetch(BASE_URL + "/api/v1/workingorders", {
  method: "POST",
  headers: {
    "CST": process.env.CAPITAL_CST,
    "X-SECURITY-TOKEN": process.env.CAPITAL_SECURITY_TOKEN,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"direction": "...", "epic": "...", "size": 0, "level": 0, "type": "..."}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

curl

# Set CAPITAL_CST, CAPITAL_SECURITY_TOKEN as environment variables first. Never paste real values into code.
# CAPITAL_CST and CAPITAL_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /api/v1/session returns: step 3 of the quickstart (/brokers/capital-com/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 goodTillDate, guaranteedStop, trailingStop, stopLevel, stopDistance, stopAmount, profitLevel, profitDistance, profitAmount.
curl -X POST "https://demo-api-capital.backend-capital.com/api/v1/workingorders" \
  -H "CST: $CAPITAL_CST" \
  -H "X-SECURITY-TOKEN: $CAPITAL_SECURITY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"direction": "...", "epic": "...", "size": 0, "level": 0, "type": "..."}'

Response

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

{
  "_mock": true,
  "dealReference": "o_MOCK-REF-0002"
}

Response schema, HTTP 200

Every field this site's OpenAPI file for Capital.com declares for this response.

Field	Type	Description
dealReference	string	Not 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 Capital.com

Limit	Value	Scope	Source
Headline limit	10/s per user	user	open-api.capital.comchecked 18 Sep 2026

Capital.com API errors you may meet

All Capital.com API error codes, including 18 more not listed here.