Capital.com API GET /api/v1/session

GET/api/v1/sessionversion v1Session

Read the current session: client ID, active account, locale, currency and the streaming endpoint.

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

Listed on the official reference at open-api.capital.com (opened on the date shown). Parameters and example fields from Capital.com's official Postman collection. 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

No parameters recorded beyond authentication.

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.

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.
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"],
}
resp = requests.get(BASE_URL + "/api/v1/session", headers=headers, 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.
// 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/session", {
  method: "GET",
  headers: {
    "CST": process.env.CAPITAL_CST,
    "X-SECURITY-TOKEN": process.env.CAPITAL_SECURITY_TOKEN,
  },
});
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.
curl -X GET "https://demo-api-capital.backend-capital.com/api/v1/session" \
  -H "CST: $CAPITAL_CST" \
  -H "X-SECURITY-TOKEN: $CAPITAL_SECURITY_TOKEN"

Response

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

{
  "_mock": true,
  "clientId": "MOCK-CLIENT-01",
  "accountId": "MOCK-ACCOUNT-001",
  "timezoneOffset": 1,
  "locale": "en",
  "currency": "USD",
  "streamEndpoint": "wss://api-streaming-capital.backend-capital.com/"
}

Response schema, HTTP 200

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

Field	Type	Description
clientId	string	Not recorded
accountId	string	Not recorded
timezoneOffset	integer	Not recorded
locale	string	Not recorded
currency	string	Not recorded
streamEndpoint	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.