cTrader ProtoOARefreshTokenRes
messageProtoOARefreshTokenRescTrader Open APIpayloadType 2174Authorisation
Returns the new access token, how long it lasts and a new refresh token.
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 cTrader Open API, not an HTTP endpoint. It has no method and no path: it is sent over an open TCP or WebSocket connection, as Protocol Buffers or as JSON.
The message
- Name
- ProtoOARefreshTokenRes
- Direction
- Response, sent by the server
- Payload type
- PROTO_OA_REFRESH_TOKEN_RES, number 2174. This number is what identifies the message on the wire.
- Answers
Fields
| Name | Type | Description |
|---|---|---|
| payloadType | ProtoOAPayloadType | Identifies the message. Its default in the definition is PROTO_OA_REFRESH_TOKEN_RES, which is number 2174. |
| accessTokenrequired | string | The new access token. A credential: keep it out of source code and logs. |
| tokenTyperequired | string | The kind of token. The definition gives the value bearer. |
| expiresInrequired | int64 | How long the new access token lasts, in seconds. |
| refreshTokenrequired | string | The new refresh token, which replaces the one that was sent. |
Limits that apply at cTrader Open API
| Limit | Value | Scope | Source |
|---|---|---|---|
| Requests a second, not historical data | 50 | Per connection, requests that are not for historical data | help.ctrader.comchecked |
| Requests a second, historical data | 5 | Per connection, historical data requests only | help.ctrader.comchecked |