Broker API HubMenu

cTrader ProtoOAClosePositionReq

messageProtoOAClosePositionReqcTrader Open APIpayloadType 2111Orders and positions

Closes an open position, in full or in part. The definition allows it only where the access token has trade permission for the account.

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 unofficialhelp.ctrader.comchecked The definition file it was checked against

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
ProtoOAClosePositionReq
Direction
Request, sent by the client
Payload type
PROTO_OA_CLOSE_POSITION_REQ, number 2111. This number is what identifies the message on the wire.

Fields

NameTypeDescription
payloadTypeProtoOAPayloadTypeIdentifies the message. Its default in the definition is PROTO_OA_CLOSE_POSITION_REQ, which is number 2111.
ctidTraderAccountIdrequiredint64The 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.
positionIdrequiredint64The position to close, by its id.
volumerequiredint64How much of the position to close. 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": 2111,
  "payload": {
    "ctidTraderAccountId": 12345678,
    "positionId": 123456,
    "volume": 100000
  }
}

Limits that apply at cTrader Open API

LimitValueScopeSource
Requests a second, not historical data50Per connection, requests that are not for historical datahelp.ctrader.comchecked
Requests a second, historical data5Per connection, historical data requests onlyhelp.ctrader.comchecked