Investments Solutions

Liquidations

Download Spec

All accounts liquidations related paths.

get/accounts/{account_id}/liquidations

List accounts liquidations

sortstring

Sort the result by id.

Default: "id"
Enum: id

orderstring

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default: "ASC"
Enum: ASC

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

start_datestring

Returns accounts liquidations created starting from and including this date (UTC)

Example: "2022-10-14T10:10:10Z"

end_datestring

Returns accounts liquidations created up until this date (UTC)

Example: "2022-10-14T10:10:10Z"

Responses

Response examples

Accounts liquidations

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "c5869b0c-e107-4e68-a89a-57ad43253dd6",
      "created_at": "2021-07-21T14:10:00.000Z",
      "updated_at": "2021-07-21T14:10:00.000Z",
      "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
      "cash_amount": "1000",
      "currency": "EUR",
      "status": "PROCESSING",
      "orders": [
        {
          "id": "b291d8a4-21f5-4c52-8590-4f90ce54d0b1",
          "side": "SELL",
          "status": "NEW"
        },
        {
          "id": "81d02bd9-7b9d-443d-bbfa-31df4d543f7d",
          "side": "SELL",
          "status": "PROCESSING"
        },
        {
          "id": "e97fb564-ebb4-4f37-930a-bda49c09a2e4",
          "side": "SELL",
          "status": "FILLED"
        }
      ]
    }
  ]
}

post/accounts/{account_id}/liquidations

Create account liquidation request

user_idstring

required

User unique identifier.

Format: uuid

Responses

Request examples

{
  "user_id": "084a00a8-4a37-4d2d-b276-71ec5e2be0e3"
}

Response examples

Account liquidation object

{
  "id": "b2f541dc-a27b-4d5a-b970-41812b0892b9",
  "created_at": "2021-07-21T14:10:00.000Z",
  "updated_at": "2021-07-21T14:10:00.000Z",
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "user_id": "81dfb00e-9be6-4617-8994-dfd0407f34df",
  "cash_amount": "1000",
  "currency": "EUR",
  "status": "NEW",
  "orders": []
}

get/accounts/{account_id}/liquidations/{account_liquidation_id}

Retrieve account liquidation

account_idstring

required

Account unique identifier.

Format: uuid

account_liquidation_idstring

required

Format: uuid

Responses

Response examples

Account liquidation object

{
  "id": "f386fdc4-dcd8-4dce-8acb-dae332f51483",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "4b9732bd-7496-4e91-8a5f-6360479d7fed",
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "cash_amount": "100.00",
  "currency": "EUR",
  "status": "PROCESSING",
  "orders": [
    {
      "id": "79f2c816-13ed-4588-85e6-f3398b0b5825",
      "side": "SELL",
      "status": "NEW"
    },
    {
      "id": "44f50a4e-7ce8-4eae-a078-f4b3d8ab4708",
      "side": "SELL",
      "status": "NEW"
    }
  ]
}

delete/accounts/{account_id}/liquidations/{account_liquidation_id}

Cancel account liquidation

account_idstring

required

Account unique identifier.

Format: uuid

account_liquidation_idstring

required

Format: uuid

Responses

Response examples

Request has been processed successfully.

Empty response

webhook

Account liquidation events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Enum: ACCOUNT_LIQUIDATION.NEW
ACCOUNT_LIQUIDATION.PROCESSING
ACCOUNT_LIQUIDATION.FILLED
ACCOUNT_LIQUIDATION.CANCELLED
ACCOUNT_LIQUIDATION.SETTLED

objectobject (Account liquidation)

required

idstring

required

Format: uuid

created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format: date-time

updated_atstring

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

Format: date-time

user_idstring

User unique identifier.

Format: uuid

account_idstring

required

Account unique identifier.

Format: uuid

cash_amountstring

required

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

currencystring

required

Alphabetic three-letter ISO 4217 currency code.

EUR - Euro
GBP - British Pound

Enum: EUR
GBP

statusstring

required

Execution status of the Account liquidation.

NEW -
PROCESSING -
FILLED -
CANCELLED -
SETTLED -

Enum: NEW
PROCESSING
FILLED
CANCELLED
SETTLED

ordersarray

required

Position liquidation orders associated with this account liquidation

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "56510309-d9de-4730-9b5b-4a0ed047f3a9",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "ACCOUNT_LIQUIDATION.NEW",
  "object": {
    "id": "b2f541dc-a27b-4d5a-b970-41812b0892b9",
    "created_at": "2021-07-21T14:10:00.000Z",
    "updated_at": "2021-07-21T14:10:00.000Z",
    "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
    "user_id": "81dfb00e-9be6-4617-8994-dfd0407f34df",
    "cash_amount": "1000",
    "currency": "EUR",
    "status": "NEW",
    "orders": []
  },
  "webhook_id": "b838bde5-b6df-4f1f-bfc4-71d3fb01d430"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?