Capital.com ping
Keeps the WebSocket connection alive. Capital.com's page says to send it at least once every 10 minutes. It carries the two session tokens and no payload.
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.
This is a message of the Capital.com WebSocket API, not an HTTP endpoint. It has no method and no path: it is sent as JSON over an open WebSocket connection.
The message
- Name
- ping
- Direction
- Request, sent by the client
- Carried by
- WebSocket. Capital.com's page says to ping the service at least once every 10 minutes to keep the connection alive.
- WebSocket address
- wss://api-streaming-capital.backend-capital.com/connect
Fields
The vendor's page does not say which of these fields are required or always present.
| Name | Type | Description |
|---|---|---|
| destination | Not stated | Names the message, in the way a path names a REST call. Here it is ping. |
| correlationId | Not stated | An id of your own. The answer carries the same value, which is how an answer is matched to its request. |
| cst | Not stated | The token that identifies the client. It is the CST value returned when a session is started over REST. |
| securityToken | Not stated | The token that identifies the account in use. It is the X-SECURITY-TOKEN value returned when a session is started over REST. |
What arrives
ping: The answer to a ping.
The vendor's page does not say which of these fields are required or always present.
| Name | Type | Description |
|---|---|---|
| status | Not stated | OK in the vendor's example of a successful answer. |
| destination | Not stated | The destination of the request it answers: ping. |
| correlationId | Not stated | The correlationId the request carried. |
| payload | Not stated | An empty object in the vendor's example. |
Sample
Written by this site from the fields recorded on this page. It has not been run against a terminal, a server or an account, and the values in it are placeholders. No credential is typed into it: where a field holds one, the placeholder says where it comes from. Nothing is entered on this site.
{
"destination": "ping",
"correlationId": "5",
"cst": "<the CST token of your session, from your own environment>",
"securityToken": "<the X-SECURITY-TOKEN of your session, from your own environment>"
}Limits that apply at Capital.com
| Limit | Value | Scope | Source |
|---|---|---|---|
| Headline limit | 10/s per user | user | open-api.capital.comchecked |