For the complete documentation index, see llms.txt. This page is also available as Markdown.

add algo (synthetic and GTC orders)

Places new order

POST /algo/order/add

{
  "instrument": "ETH-USD:USDT-USD",
  "clientOrderId": 1,
  "side": "ask",
  "size": 12345678,
  "volume": 12345678,
  "price": 12345678,
  "type": "limitIOC",
  "firmBookEnabled": true,
  "qsEnabled": false
}
Parameter
Type
Description

instrument

string

Instrument Technical Name. Might be Synthetic Instrument (e.g., ETH-USD:USDT-USD) or Direct Instrument (e.g., ETH-USD)

clientOrderId

Efx::ClientOrderId

Client Order ID. See Data Types.

side

string

Order side. Might be bid or ask.

size

Efx::Size

Order size. See Data Types. Must be present only if no volume provided.

volume

Efx::Size

Order volume. See Data Types. Must be present only if no size provided.

price

Efx::Price

Order price. See Data Types. Must be present only if placing limit order

type

string

Order type. For orders with Synthetic Instruments might be one of limitIOC or marketIOC. For Pending limit orders must be pendingLimit

firmBookEnabled

boolean

At the moment must be true for every order

qsEnabled

boolean

At the moment must be false for every order

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 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

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

Last updated