cTrader ProtoOAGetAccountListByAccessTokenRes
messageProtoOAGetAccountListByAccessTokenRescTrader Open APIpayloadType 2150Authorisation
Lists the trading accounts the access token covers, with the scope of permission the token carries.
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
- ProtoOAGetAccountListByAccessTokenRes
- Direction
- Response, sent by the server
- Payload type
- PROTO_OA_GET_ACCOUNTS_BY_ACCESS_TOKEN_RES, number 2150. This number is what identifies the message on the wire.
Fields
| Name | Type | Description |
|---|---|---|
| payloadType | ProtoOAPayloadType | Identifies the message. Its default in the definition is PROTO_OA_GET_ACCOUNTS_BY_ACCESS_TOKEN_RES, which is number 2150. |
| accessTokenrequired | string | The access token issued for the trading account through the OAuth flow. A credential: keep it out of source code. |
| permissionScope | ProtoOAClientPermissionScope | What the token allows, as a value of ProtoOAClientPermissionScope: SCOPE_VIEW or SCOPE_TRADE. |
| ctidTraderAccount | repeated ProtoOACtidTraderAccount | The accounts the token covers, one ProtoOACtidTraderAccount for each. |
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 |