Broker API HubMenu

Capital.com API PUT /api/v1/positions/{dealId}

PUT/api/v1/positions/{dealId}version v1Positions

Amend an open position: move or add its stop loss and take profit, or switch to a guaranteed or trailing stop. Confirm with GET /api/v1/confirms/{dealReference}.

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

Listed as Update position in Capital.com's official Postman collection (opened on the date shown), with its body parameters and examples. The reference at open-api.capital.com documents this call too, with the same body fields, each marked as not required. 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

NameInTypeDescription
dealIdrequiredpathstringPermanent deal ID of the position to amend. Mock value shown.
guaranteedStopbodybooleanTrue for a guaranteed stop. Then set stopLevel, stopDistance or stopAmount. Not allowed with trailingStop or in hedging mode.
trailingStopbodybooleanTrue for a trailing stop. Then set stopDistance. Not allowed with guaranteedStop.
stopLevelbodynumberPrice at which the stop loss triggers.
stopDistancebodynumberDistance from the current price to the stop loss. Required when trailingStop is true.
stopAmountbodynumberLoss amount at which the stop loss triggers.
profitLevelbodynumberPrice at which the take profit triggers.
profitDistancebodynumberDistance from the current price to the take profit.
profitAmountbodynumberProfit amount at which the take profit triggers.

Authentication headers

NameTypeDescription
CSTrequiredstringAccess token returned in the CST response header of POST /session. Valid for 10 minutes after last use. Placeholder only.
X-SECURITY-TOKENrequiredstringAccount 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 record marks no body field as required, so the samples send an empty JSON object with a Content-Type of application/json (in Python, passing json= sets that header). Add the fields the call needs from the parameters above 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 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 = {}
resp = requests.put(BASE_URL + "/api/v1/positions/{dealId}", 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 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/positions/{dealId}", {
  method: "PUT",
  headers: {
    "CST": process.env.CAPITAL_CST,
    "X-SECURITY-TOKEN": process.env.CAPITAL_SECURITY_TOKEN,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
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 guaranteedStop, trailingStop, stopLevel, stopDistance, stopAmount, profitLevel, profitDistance, profitAmount.
curl -X PUT "https://demo-api-capital.backend-capital.com/api/v1/positions/{dealId}" \
  -H "CST: $CAPITAL_CST" \
  -H "X-SECURITY-TOKEN: $CAPITAL_SECURITY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

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

{
  "_mock": true,
  "dealReference": "p_MOCK-DEAL-0001"
}

Response schema, HTTP 200

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

FieldTypeDescription
dealReferencestringNot 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

LimitValueScopeSource
Headline limit10/s per useruseropen-api.capital.comchecked

Capital.com API errors you may meet

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