Расчет прибыли и убытка¶

Расчет прибыли и убытка является важным вариантом использования, который должен быть реализован практически в каждом приложении и сервисе cTrader Open API.

Ручной расчет прибыли и убытка — это сложный процесс, поскольку расчет должен учитывать размер позиции и возможную конвертацию между котируемым активом купленного или проданного инструмента и валютой депозита счета.

К счастью, вы можете просто попросить бэкенд cTrader рассчитать прибыль и убыток для вас, отправив сообщение ProtoOAGetPositionUnrealizedPnLReq. Вы должны получить сообщение ProtoOAGetPositionUnrealizedPnLRes, содержащее модельное сообщение ProtoOAPositionUnrealizedPnL в одном из его полей.

Примечание

ProtoOAGetPositionUnrealizedPnLRes содержит информацию о прибыли и убытках всех текущих открытых позиций счета с указанным ctidTraderAccountId в его повторяющемся поле positionUnrealizedPnL.

Ограничения частоты операций

Запрос прибыли и убытка является неисторическим запросом, что означает, что вы можете выполнять максимум 50 таких запросов в секунду. Мы рекомендуем обновлять прибыль и убыток один раз в две-три секунды, чтобы не было риска превышения ограничений по частоте запросов.

Узнайте больше об отправке и получении сообщений в руководствах по Protobuf и JSON.

При работе с Protobuf вы можете использовать классы, сгенерированные компилятором, для сериализации и десериализации сообщения для получения курсов прибыли и убытка. При работе с JSON вам нужно будет создать такие классы самостоятельно. Вот пример того, как они могут выглядеть.

C#Python

public abstract class OpenAPIModelMessageBase { }

public class PositionUnrealizedPnL : OpenAPIModelMessageBase
{
    public PositionUnrealizedPnL() { }
    public PositionUnrealizedPnL(int positionId, int grossUnrealizedPnL, int netUnrealizedPnL) 
    {
        this.PositionId = positionId;
        this.GrossUnrealizedPnL = grossUnrealizedPnL;
        this.NetUnrealizedPnL = netUnrealizedPnL;
    }

    public int PositionId { get; set; }
    public int GrossUnrealizedPnL { get; set; }
    public int NetUnrealizedPnL { get; set; }
}

public class GetPositionUnrealizedPnLReq : OpenAPIMessageBase
{
    public GetPositionUnrealizedPnLReq() { }
    public GetPositionUnrealizedPnLReq(int ctidTraderAccountId)
    {
        this.Payload = new GetPositionUnrealizedPnLReqPayload(ctidTraderAccountId);
        this.ClientMsgId = Guid.NewGuid().ToString();
    }

    public override int PayloadType => 2187;
    public GetPositionUnrealizedPnLReqPayload? Payload { get; set; }
}

public class GetPositionUnrealizedPnLReqPayload : OpenAPIMessagePayloadBase
{
    public GetPositionUnrealizedPnLReqPayload() { }
    public GetPositionUnrealizedPnLReqPayload(int ctidTraderAccountId)
    {
        this.CtidTraderAccountId = ctidTraderAccountId;
    }

    public int CtidTraderAccountId { get; set; } = 0;

}

public class GetPositionUnrealizedPnLRes : OpenAPIMessageBase 
{
    public GetPositionUnrealizedPnLRes() { }
    public GetPositionUnrealizedPnLRes(int ctidTraderAccountId, int moneyDigits, List<PositionUnrealizedPnL> positionUnrealizedPnL)
    {
        this.Payload = new GetPositionUnrealizedPnLResPayload(ctidTraderAccountId, moneyDigits, positionUnrealizedPnL);
        this.ClientMsgId = Guid.NewGuid().ToString();
    }

    public override int PayloadType => 2188;
    public GetPositionUnrealizedPnLResPayload? Payload { get; set; }

}

public class GetPositionUnrealizedPnLResPayload : OpenAPIMessagePayloadBase
{
    public GetPositionUnrealizedPnLResPayload() { }
    public GetPositionUnrealizedPnLResPayload(int ctidTraderAccountId, int moneyDigits, List<PositionUnrealizedPnL> positionUnrealizedPnL)
    {
        this.CtidTraderAccountId = ctidTraderAccountId;
        this.MoneyDigits = moneyDigits;
        this.PositionUnrealizedPnL = positionUnrealizedPnL;
    }

    public int CtidTraderAccountId { get; set; } = 0;
    public int MoneyDigits { get; set; } = 0;
    public List<PositionUnrealizedPnL> PositionUnrealizedPnL { get; set; } = new List<PositionUnrealizedPnL>();
}

class OpenAPIModelMessage:
    def __init__(self):
        pass

class PositionUnrealizedPnL(OpenAPIModelMessage):
    def __init__(self, position_id, gross_unrealized_pnl, net_unrealized_pnl):
        self.position_id = position_id
        self.gross_unrealized_pnl = gross_unrealized_pnl
        self.net_unrealized_pnl = net_unrealized_pnl

class GetPositionUnrealizedPnLReq(OpenAPIMessage):
    def __init__(self, ctid_trader_account_id, client_msg_id = str(uuid.uuid4())):
        self.ctid_trader_account_id = ctid_trader_account_id
        self.payload_type = 2187
        self.client_msg_id = client_msg_id
        self.payload = {"ctidTraderAccountId": self.ctid_trader_account_id}

    def as_json_string(self):
        return json.dumps({"clientMsgId": self.client_msg_id, "payloadType": self.payload_type, "payload": self.payload})

    @staticmethod
    def from_json(json_dct):
        return GetPositionUnrealizedPnLReq(client_id=json_dct['payload']['clientId'], client_secret=json_dct['payload']['clientSecret'], client_msg_id=json_dct['clientMsgId'])

class GetPositionUnrealizedPnLRes(OpenAPIMessage):
    def __init__(self, ctid_trader_account_id, position_unrealized_pnl, money_digits, client_msg_id):
        self.ctid_trader_account_id = ctid_trader_account_id
        self.position_unrealized_pnl = position_unrealized_pnl
        self.money_digits = money_digits
        self.client_msg_id = client_msg_id

    def as_json_string(self):
        return json.dumps({"clientMsgId": self.client_msg_id, "payloadType": self.payload_type, "payload": self.payload})

    @staticmethod
    def from_json(json_dct):
        return GetPositionUnrealizedPnLRes(ctid_trader_account_id=json_dct['payload']['clientSecret'], position_unrealized_pnl=json_dct['payload']['positionUnrealizedPnL'], money_digits=json_dct['payload']['moneyDigits'], client_msg_id=['clientMsgId'])