All portfolio trades

Private resource

The request cannot be executed anonymously. The required token parameter must contain an up-to-date Access Token.

HTTP API

This operation can be performed with request to HTTP API.

The request creates a subscription to receive information about all transactions made using the specified portfolio.

---

Request

To create a subscription to a data channel, send a message to the established WebSocket connection with a request body containing the details of the subscription to be created.

Request body

{
  "opcode": "TradesGetAndSubscribeV2",
  "portfolio": "D39004",
  "skipHistory": false,
  "exchange": "MOEX",
  "instrumentGroup": "TQBR",
  "format": "Simple",
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "token": "eyJhbGciOiJ..."
}

Schema

Request body parameters

opcodestringrequired
Operation code:
• OrderBookGetAndSubscribe — Subscription to order book
• BarsGetAndSubscribe — Subscription to price history (candlesticks)
• QuotesSubscribe — Subscription to quotes
• InstrumentsGetAndSubscribeV2 — Subscription to security information updates on the selected exchange
• AllTradesGetAndSubscribe — Subscribe to all trades
• PositionsGetAndSubscribeV2 — Subscription to information about current positions on securities and money
• SummariesGetAndSubscribeV2 — Subscription to portfolio summary information
• RisksGetAndSubscribe — Subscription to consolidated information on portfolio risks
• SpectraRisksGetAndSubscribe — Subscription to information on derivatives market risks (FORTS)
• TradesGetAndSubscribeV2 — Subscription for information on trades
• OrdersGetAndSubscribeV2 — Subscription to information about current orders on the market for the selected exchange and security
• StopOrdersGetAndSubscribeV2 — Subscription to information about current conditional orders in the market for the selected exchange and security
• unsubscribe — Cancelation of previously created subscription
portfoliostringrequired

Client portfolio ID

Example: D39004

skipHistoryboolean

Flag for filtering out historical data:

• true — display only new data
• false — display including historical data

Example: false

orderStatusesstring

Optional filter by order statuses. Affects only the filtering of primary historical data at subscription. Possible values:

• working — Waiting for execution
• filled — Executed
• canceled — Canceled
• rejected — Rejected

Example: filled

exchangestringrequired

Exchange code:

• MOEX — Moscow Exchange
• SPBX — SPB Exchange

Example: MOEX

instrumentGroupstring

Trading mode code (Board):

• List of Moscow Exchange codes is available in table
• SPB Exchange securities always have SPBX code

Example: TQBR

formatstring

The format of the JSON object returned by the server:

• Simple is the original data format. Supports legacy (deprecated) parameters to ensure backward compatibility
• Slim is the lightweight data format for fast messaging. Does not support legacy (deprecated) parameters
• Heavy is the complete data format, evolving and augmented with new fields. Does not support legacy (deprecated) parameters

Example: Simple

guidstringrequired

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

tokenstringrequired

Access Token

Example: eyJhbGciOiJ...

---

Responses

The content of the response returned to the WebSocket connection depends on the results of processing the request:

• If the request is processed successfully, the server will send one 200 code message in response, confirming that the subscription has been created, after which it will begin transmitting 100 code messages containing the information requested as part of the subscription.
• If the request processing failed, the server will send back one message with an error code corresponding to the reason for the failure, after which it will close the WebSocket connection.

100

Messages from the channel containing the requested information

Simple

Response body

{
  "data": {
    "id": "4421925358",
    "orderno": "42030831469",
    "comment": null,
    "symbol": "GAZP",
    "brokerSymbol": "MOEX:GAZP",
    "exchange": "MOEX",
    "date": "2023-12-29T12:35:06.0000000Z",
    "board": "TQBR",
    "qtyUnits": 10,
    "qtyBatch": 1,
    "qty": 1,
    "price": 170.21,
    "accruedInt": 0,
    "side": "buy",
    "existing": true,
    "commission": 1.361050,
    "repoSpecificFields": null,
    "volume": 1702.10
  },
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}

Schema

Response body parameters

data

object

Requested data

iddecimal

Unique trade ID

Example: 4421925358

ordernostring

Order ID

Example: 0

commentstring

Custom comment

Example: First order

symbolstring

Security code (ticker). [N/A] if symbol is not set

Example: SBER

brokerSymbolstring

Exchange-Ticker Pair

Example: MOEX:ALRS-3.24

exchangestring

Exchange code:

• MOEX — Moscow Exchange
• SPBX — SPB Exchange

Example: MOEX

datedate-time

Date and time (UTC) of order closing.

Example: 2023-12-29T12:35:06.0000000Z

boardstring

Trading mode code (Board):

• List of Moscow Exchange codes is available in table
• SPB Exchange securities always have SPBX code

Example: TQBR

qtyUnitsint32

Number of units

Example: 1

qtyBatchint32

Number of lots

Example: 1

qtyint32

Quantity

Example: 5

pricedecimal

Price

Example: 271.57

accruedIntdecimal

Accrued interest

Example: 0

sidestring

Transaction side:

• buy
• sell

Example: sell

existingboolean

True will return the response including data from snapshot, i.e. from history. False will return only new events

Example: false

commissiondecimal

Total commission (null for derivatives)

Example: 1,36

repoSpecificFields

object

Special fields for repo trades

repoRatedecimal

Repo price in percent per annum

Example: 23.45

extRefstring

Note field, used for providing information feedback to external systems. For example, the ID of the user of the external system that placed the request.

Example: MB0014100002

repoTermint32

Repo term - the period of time, expressed in calendar days, between the dates of execution of the first and second parts of a repo transaction.

Example: 2

accountstring

Trading account on behalf of which the transaction is concluded

Example: MB0014100002

tradeTypeInfostring

Trade type description

Example: Swap settlement

valuedecimal

Transaction volume represented in the settlement currency

Example: 46

yieldint32

Yield calculated at the transaction price

Example: null

volumedecimal

Volume calculated at average price

Example: 1702.10

guidstring

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

Slim

Response body

{
  "data": {
    "id": "4421925358",
    "eid": "42030831469",
    "cmt": null,
    "sym": "GAZP",
    "tic": "MOEX:GAZP",
    "ex": "MOEX",
    "d": "2023-12-29T12:35:06.0000000Z",
    "b": "TQBR",
    "q": 10,
    "qb": 1,
    "px": 170.21,
    "ai": 0,
    "s": "buy",
    "h": true,
    "cms": 1.361050,
    "r": null,
    "v": 1702.10
  },
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}

Schema

Response body parameters

data

object

Requested data

iddecimal

Unique trade ID

Example: 4421925358

eidstring

Order ID

Example: 0

cmtstring

Custom comment

Example: First order

symstring

Security code (ticker). [N/A] if symbol is not set

Example: SBER

ticstring

Exchange-Ticker Pair

Example: MOEX:ALRS-3.24

exstring

Exchange code:

• MOEX — Moscow Exchange
• SPBX — SPB Exchange

Example: MOEX

ddate-time

Date and time (UTC) of order closing.

Example: 2023-12-29T12:35:06.0000000Z

bstring

Trading mode code (Board):

• List of Moscow Exchange codes is available in table
• SPB Exchange securities always have SPBX code

Example: TQBR

qint32

Number of units

Example: 1

qbint32

Number of lots

Example: 1

pxdecimal

Price

Example: 271.57

aidecimal

Accrued interest

Example: 0

sstring

Transaction side:

• buy
• sell

Example: sell

hboolean

True will return the response including data from snapshot, i.e. from history. False will return only new events

Example: false

cmsdecimal

Total commission (null for derivatives)

Example: 1,36

r

object

Special fields for repo trades

rdecimal

Repo price in percent per annum

Example: 23.45

exrstring

Note field, used for providing information feedback to external systems. For example, the ID of the user of the external system that placed the request.

Example: MB0014100002

tmint32

Repo term - the period of time, expressed in calendar days, between the dates of execution of the first and second parts of a repo transaction.

Example: 2

astring

Trading account on behalf of which the transaction is concluded

Example: MB0014100002

tstring

Trade type description

Example: Swap settlement

vdecimal

Transaction volume represented in the settlement currency

Example: 46

yint32

Yield calculated at the transaction price

Example: null

vdecimal

Volume calculated at average price

Example: 1702.10

guidstring

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

Heavy

Response body

{
  "data": {
    "id": "4421925358",
    "orderNo": "42030831469",
    "comment": null,
    "symbol": "GAZP",
    "brokerSymbol": "MOEX:GAZP",
    "exchange": "MOEX",
    "date": "2023-12-29T12:35:06.0000000Z",
    "board": "TQBR",
    "qtyUnits": 10,
    "qtyBatch": 1,
    "qty": 1,
    "price": 170.21,
    "accruedInt": 0,
    "side": "buy",
    "existing": true,
    "commission": 1.361050,
    "repoSpecificFields": null,
    "volume": 1702.10,
    "settleDate": "2024-12-31T23:59:59.9990000Z"
  },
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}

Schema

Response body parameters

data

object

Requested data

iddecimal

Unique trade ID

Example: 4421925358

orderNostring

Order ID

Example: 0

commentstring

Custom comment

Example: First order

symbolstring

Security code (ticker). [N/A] if symbol is not set

Example: SBER

brokerSymbolstring

Exchange-Ticker Pair

Example: MOEX:ALRS-3.24

exchangestring

Exchange code:

• MOEX — Moscow Exchange
• SPBX — SPB Exchange

Example: MOEX

datedate-time

Date and time (UTC) of order closing.

Example: 2023-12-29T12:35:06.0000000Z

boardstring

Trading mode code (Board):

• List of Moscow Exchange codes is available in table
• SPB Exchange securities always have SPBX code

Example: TQBR

qtyUnitsint32

Number of units

Example: 1

qtyBatchint32

Number of lots

Example: 1

qtyint32

Quantity

Example: 5

pricedecimal

Price

Example: 271.57

accruedInterestdecimal

Accrued interest

Example: 0

sidestring

Transaction side:

• buy
• sell

Example: sell

existingboolean

True will return the response including data from snapshot, i.e. from history. False will return only new events

Example: false

commissiondecimal

Total commission (null for derivatives)

Example: 1,36

repoSpecificFields

object

Special fields for repo trades

repoRatedecimal

Repo price in percent per annum

Example: 23.45

extRefstring

Note field, used for providing information feedback to external systems. For example, the ID of the user of the external system that placed the request.

Example: MB0014100002

repoTermint32

Repo term - the period of time, expressed in calendar days, between the dates of execution of the first and second parts of a repo transaction.

Example: 2

accountstring

Trading account on behalf of which the transaction is concluded

Example: MB0014100002

tradeTypeInfostring

Trade type description

Example: Swap settlement

valuedecimal

Transaction volume represented in the settlement currency

Example: 46

yieldint32

Yield calculated at the transaction price

Example: null

volumedecimal

Volume calculated at average price

Example: 1702.10

settleDatedate-time

UTC date of fulfillment of transaction obligations

Example: 2024-12-31T23:59:59.9990000Z

guidstring

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

200

Successful request processing report

Body

{
  "message": "Handled successfully",
  "httpCode": 200,
  "requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}

Schema

Response body parameters

messagestring

Text description of the returned HTTP code

Example: Handled successfully

httpCodeint32

HTTP message code

Example: 200

requestGuidstring

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

401

Failed to process request. Access token is invalid, not specified in the message or belongs to other system environment

Body

{
  "requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "httpCode": 401,
  "message": "Invalid JWT token!"
}

Schema

Response body parameters

requestGuidstring

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

httpCodeint32

HTTP message code

Example: 401

messagestring

Text description of the returned HTTP code

Example: Invalid JWT token!