order (authorized)

Retrieves existing order information on behalf of another client

Payload

POST /algo/order

{
  "clientId": 10,
  "id": 123456
}

Parameter	Type	Description
clientId	Efx::ClientId	Will retrieve order on behalf of this client. See Data Types.
id	Efx::OrderId	Order ID. See Data Types.

Response 200 OK

{
  "content": {
    "id": 123456,
    "clientOrderId": 1,
    "clientId": 10,
    "masterId": 9999,
    "status": "PARTIALLY_EXECUTED",
    "side": "ask",
    "initiatorType": "regular",
    "instrument": "ETH-USD:USDT-USD",
    "size": 12345678,
    "volume": 12345678,
    "price": 12345678,
    "remainingSizeOrVolume": 123,
    "createdAt": 1767225600,
    "type": "limitIOC",
    "cancelReason": "some",
    "filledPercent": 9500,
    "executionSize": 12345678,
    "executionVolume": 12345678,
    "orders": [
      {
        "orderId": 123456,
        "executionIndex": 0,
        "side": "ask",
        "instrument": "ETH-USD",
        "size": 12345678,
        "executionSize": 12345678,
        "executionVolume": 12345678,
        "executionCode": 0
      },
      ...
    ]
  },
  "error": 0
}

Attribute	Type	Description
error	Efx::ErrorCode	Operation result code. Possible values are in List of Error Codes
content.id	Efx::OrderId	Order ID. See Data Types.
content.clientOrderId	Efx::ClientOrderId	Client Order ID. See Data Types.
content.clientId	Efx::ClientId	ID of a client on behalf of which order was placed. See Data Types.
content.masterId	Efx::ClientId	ID of a client who placed order. See Data Types.
content.status	string	Order status. Might be PENDING, PARTIALLY_EXECUTED, COMPLETED, CANCELED
content.side	string	Order side. Might be bid, ask
content.initiatorType	string	Order Initiator type. Always regular
content.instrument	string	Technical name of order instrument
content.size	Efx::Size	Order size. See Data Types. Will be present if order is by size.
content.volume	Efx::Size	Order volume. See Data Types. Will be present if order is by volume.
content.price	Efx::Price	Order price. See Data Types. Will be present for limit orders only.
content.remainingSizeOrVolume	Efx::Size	For orders by size: remaining order size after order execution. For orders by volume: remaining order volume after order execution
content.createdAt	Efx::Timestamp	Order creation date
content.type	string	Order type. One of limitIOC, marketIOC, pendingLimit
content.cancelReason	string	Order cancel reason. Will be present in cancelled orders
content.filledPercent	Efx::Percent	How many of initial size/volume turned into balance asset, in %. Currently present for Synthetic orders only
content.executionSize	Efx::Size	Execution Size, asset currency. Currently present for Synthetic orders only
content.executionVolume	Efx::Size	Execution Volume, balance currency. Currently present for Synthetic orders only
content.orders	order array	List of Child orders that relate to specified Algo order. Currently present for Synthetic orders only

Schema for order attribute:

orderId	Efx::OrderId	Child Order ID. See Data Types.
executionIndex	number	Child order execution index, starting from 0
side	string	Child Order side. Might be bid, ask
instrument	string	Technical name of child order instrument
size	Efx::Size	Child Order size. See Data Types. Will be present if child order is by size.
volume	Efx::Size	Child Order volume. See Data Types. Will be present if child order is by volume.
price	Efx::Price	Child Order price. See Data Types. Will be present for limit orders only.
executionSize	Efx::Size	Execution Size, asset currency. See Data Types.
executionVolume	Efx::Size	Execution Volume, balance currency. See Data Types.
remainingSizeOrVolume	Efx::Size	For orders by size: remaining order size after order execution. For orders by volume: remaining order volume after order execution. See Data Types.
cancelReason	Efx::CancelReason	Order cancel reason. Will be present in cancelled orders. See Data Types.
executionCode	Efx::ErrorCode	Child order result code. Possible values are in List of Error Codes

Response NoOK

{
    "error": 9,
    "errorDescription": [
        "Some description"
    ]
}

Attribute	Type	Description
error	Efx::ErrorCode	Operation result code. Possible values are in List of Error Codes
errorDescription	string array	List of strings describing observed errors