add

Places an order. Taker can specify order volume instead of order size.

POST /add

{
    "instrument": "BTC-USD",
    "clientOrderId": 123456789,
    "price": 999900000000,
    "size": 10000000,
    "side": "bid",
    "type": "limitIOC",
    "cod": false
}

Request parameters

Field nameTypeDescription

instrument

string

Instrument name

clientOrderId

Efx::ClientOrderId

User data attached to the order

price

Efx::Price

Order limit price (for postOnly and limit orders)

size

Efx::Size

Order size. If specified - volume shouldn't be used

volume

Efx::Size

Order volume to be filled. Can be used by takers only. If specified - size shouldn't be used

side

string

Order side, use "bid" to buy and "ask" to sell

type

string

Order types "limitIOC", "limitFOK", "marketIOC", "marketFOK" can only be used by market takers. "postOnly" and "limit" can only be used by market makers.

cod

boolean

Cancel On Disconnect flag (will be used only within Web Socket authenticated connection)

Response description

Filed nameTypeDescription

id

Efx:OrderId

New Order Id

clientOrderId

Efx::ClientOrderId

Optional user data attached to the order

remainingSize

Efx::Size

Remaining Order size after aggressive deals (if order was placed by size)

remainingVolume

Efx::Size

Remaining Order size after aggressive deals (if order was placed by volume)

cancelReason

unsigned int16

Cancel Reason:

0 - the order is filled (for Takers)

1 - by client (for Market Makers)

2 - the order has been partially filled (for Takers)

3 - by self-trade prevention (not in use)

4- on disconnect (for Market Makers) If "cancelReason" field is missing in response, it means that its value equals to 0.

deals

array of objects

Initial (taker) deals

Deal

id

Efx::DealId

Deal Id

price

Efx::Price

Deal price

size

Efx::Size

Deal size

volume

Efx::Size

Deal volume

delta

Efx::Size

Deal delta in quote (balance) currency

counterpartyId

unsigned int64

Counterparty id

counterpartySubaccountId

Efx::ClientId

Сounterparty Subaccount Id

Last updated