Broker API HubMenu

Capital.com ohlc.event

messageohlc.eventCapital.com WebSocket APIWebSocketLive candles

Carries one candlestick bar update for an epic subscribed to with OHLCMarketData.subscribe: the open, high, low and close for one resolution and bar type.

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

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 vendor's page documents this message by one example and gives no table of its fields, so no type is recorded and nothing is said about which fields are always present.

The message

Name
ohlc.event
Direction
Event, sent by the server
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
Also sent in answer to

Fields

The vendor's page does not say which of these fields are required or always present.

NameTypeDescription
statusNot statedOK in the vendor's example.
destinationNot statedAlways ohlc.event for this message.
payload.resolutionNot statedThe width of the bar, in the same words the subscription takes, such as MINUTE_5.
payload.epicNot statedThe epic the bar is for.
payload.typeNot statedThe kind of candlestick. classic in the vendor's example.
payload.priceTypeNot statedWhich price the bar is built from. bid in the vendor's example.
payload.tNot statedThe time of the bar. In the vendor's example it is a 13 digit number, which reads as Unix time in milliseconds.
payload.hNot statedThe high of the bar.
payload.lNot statedThe low of the bar.
payload.oNot statedThe open of the bar.
payload.cNot statedThe close of the bar.

Limits that apply at Capital.com

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