Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Capital.com Public API Session API

Operations for creating, switching, and ending API sessions.

Capital.com Public API Session API is one of 8 APIs that Capital.com Public API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Session. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against 2 base URLs: https://api-capital.backend-capital.com, https://demo-api-capital.backend-capital.com.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Servers
https://api-capital.backend-capital.com
https://demo-api-capital.backend-capital.com
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Capital.com Public API Session API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-CAP-API-KEY (apiKey). An API key is passed in the header as CST (sessionToken). An API key is passed in the header as X-SECURITY-TOKEN (securityToken). By default, every request must be authenticated.

  • apiKey — Capital.com API key required for all calls.
  • sessionToken — Client session token returned after creating a session.
  • securityToken — Security token returned after creating a session.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Session 5

Operations for creating, switching, and ending API sessions.

GET
/api/v1/session/encryptionKey
Get Encryption Key
getEncryptionKey → 200
GET
/api/v1/session
Get Session Details
getSession → 200401
POST
/api/v1/session
Create New Session
createSession body → 200401
PUT
/api/v1/session
Switch Active Account
switchAccount body → 200
DELETE
/api/v1/session
Log Out Session
logOutSession → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is Error (2 properties). Each schema is shown below with its type and property counts.

GenericObject
object
Generic JSON object response.
Error
object
Generic error response.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capital-com-public-api-session-api-openapi.yml Raw ↑

Other APIs Capital.com Public API publishes across the network.

Capital.com WebSocket API
Capital.com Public API Accounts API
Capital.com Public API General API
Capital.com Public API History API
Capital.com Public API Markets API
Capital.com Public API Positions API
Capital.com Public API Working Orders API