cTrader ProtoOAExpectedMarginReq
Asks for an estimate of the margin a trade would need under the account's leverage profile, which the definition says can be done before a new order is sent.
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 definition says the estimate leaves out the ACCORDING_TO_GSL way of calculating margin.
The message
- Name
- ProtoOAExpectedMarginReq
- Direction
- Request, sent by the client
- Payload type
- PROTO_OA_EXPECTED_MARGIN_REQ, number 2139. This number is what identifies the message on the wire.
- Answered by
Fields
| Name | Type | Description |
|---|---|---|
| payloadType | ProtoOAPayloadType | Identifies the message. Its default in the definition is PROTO_OA_EXPECTED_MARGIN_REQ, which is number 2139. |
| ctidTraderAccountIdrequired | int64 | The account the message is about, by its cTrader account id. Responses and events carry the same id, which is how a program holding several accounts on one connection tells them apart. |
| symbolIdrequired | int64 | The symbol, by its id on the cTrader platform. Ids come from the symbol list. |
| volume | repeated int64 | The sizes to estimate for. More than one can be sent. In hundredths of a unit, so 1000 means 10.00 units. |
Sample
Written by this site from the payload type and 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.
The three outer keys, clientMsgId, payloadType and payload, are the ones Spotware's page on sending and receiving JSON gives. The sample holds the message's required and repeated fields and leaves the optional ones out. help.ctrader.comchecked
{
"clientMsgId": "msg-1",
"payloadType": 2139,
"payload": {
"ctidTraderAccountId": 12345678,
"symbolId": 1,
"volume": [
100000
]
}
}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 |