Liquidations
This guide describes how to liquidate all open positions in an account. This feature allows users to sell or liquidate all positions within their investment account so that they can quickly exit all of their investments.
Once a liquidation is completed, the account is empty, i.e. there are no more open securities positions, but the account remains in active status and can be used for other purposes.
We will describe the API endpoint, request and response formats and highlight important contextual information for integrating this feature into your platform below.
How liquidations work
In our system, a liquidation order is an instruction to sell all existing positions in an account. Each position is liquidated by creating individual orders for each instrument in the account.
The liquidation function is currently only available for accounts of type PORTFOLIO and will only be available for accounts of type TRADING at a later date.
In the meantime, if you would like to liquidate the position holdings for accounts of type TRADING, simply place unit sell orders.
Lifecycle of a liquidation
The liquidation follows our standard order approach; its entire lifecycle is represented as a series of states. The status of an account liquidation at a given point in time provides a clear view of the processing status and possible actions:
| Status | Description |
|---|---|
NEW | A liquidation request has been placed, relevant checks are being conducted. |
PROCESSING | All individual sell orders have been created. Order checks have passed and the individual orders are executed. |
FILLED | All individual orders have been executed successfully. The securities and cash positions have been updated accordingly. |
CANCELLED | The liquidation has been cancelled by you or due to an error at the trading partner. |
Liquidation object
Example
{
"id": "10bfd760-dbf0-4302-b415-7ac7ffec7a52",
"created at": "2021-07-21T14:10:00.000Z",
"updated_at": "2021-07-21T14:10:00.000Z",
"account_id": "d7a57c3e-2be9-4c4e-b3ff-48e1e7815659",
"user_id": "2ef01903-3b0f-487c-89d8-303684d2f23c",
"cash_amount": "",
"currency": "EUR",
"status": "PROCESSING",
"orders" : [
{
"id": "6a8c5a23-abff-4faf-83bb-6c4871110409",
"side": "SELL",
"state":"NEW"
},
{
"id": "5e6dc328-7add-4ad6-9626-8f691b0369cc",
"side": "SELL",
"state": "PROCESSING"
},
{
"id": "d35f1d8c-675f-45d9-9689-48db5ed174aa",
"side": "SELL",
"state": "FILLED",
}
]
}The above example shows an ongoing liquidation for an account that had three open positions. The liquidation is still in the PROCESSING status because not all individual orders have been fully executed.
The field cash_amount is populated once all individual orders have been executed. It is important to note that each individual order in a liquidation goes through its own distinct lifecycle.
To get detailed information about the individual orders, execute