liquidationTrade

Creates trade to liquidate counterparty positions. Available only for makers.

POST api/liquidationTrade

Payload

{
    "counterpartyId": 25,
    "instrument": "BTC-USD",
    "clientOrderId": 123456789,
    "price": 999900000000,
    "size": 10000000,
    "side": "bid",
}

200 OK

{
    "id": 1245,
    "clientOrderId": 123456789,
    "deal": [
        {
            "counterpartyId": 42,
            "id": 23,
            "price": 999900000000,
            "size": 2000000,
            "volume": 19998000000,
            "delta": 0
        }
    ]
}

400 Bad request

{
    "error": 2
}

Request parameters

Field name	Type	Description
counterpartyId	Efx::ClientId	Counterparty ID to trade with.
instrument	string	Instrument name
clientOrderId	Efx::ClientOrderId	Optional. User data attached to the order
price	Efx::Price	Deal price.
size	Efx::Size	Deal size.
side	string	Deal side, use "bid" to buy and "ask" to sell

Response description

Filed name	Type	Description
id	Efx:OrderId	New Order Id
clientOrderId	Efx::ClientOrderId	Optional user data attached to the order
deal	Deal	Resulted deal.
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

The operation produces a deal in feeds 'P' and 'O'.