Skip to main content
POST
/
orderbooks
/
stocks
/
api
/
orders
/
priority
{
  "orderBookId": "ob_abc123",
  "liquidatedUser": "0x1111111111111111111111111111111111111111",
  "amount": "10000000000000000000",
  "reason": "Collateral ratio below minimum threshold"
}

{
  "success": true,
  "data": {
    "id": "pord_liq001",
    "orderBookId": "ob_abc123",
    "liquidatedUser": "0x1111111111111111111111111111111111111111",
    "amount": "10000000000000000000",
    "reason": "Collateral ratio below minimum threshold",
    "status": "EXECUTED",
    "createdAt": "2025-01-15T10:30:00.000Z"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}
Submits a priority order that takes precedence over standard orders. Designed for liquidation scenarios where a user’s collateral position must be unwound. Priority orders execute ahead of the regular order queue. The reason field should document the liquidation trigger for audit purposes.

​
Authentication

Requires an instance API key with the trading service enabled.

​
Request Body

​
orderBookId
string
required
The target order book identifier. Max 100 characters.
​
liquidatedUser
string
required
EVM address of the user being liquidated. Must match 0x[a-fA-F0-9]{40}.
​
amount
string
required
Amount to liquidate in base token units (wei). Numeric string.
​
reason
string
Human-readable reason for the liquidation. Max 256 characters.
{
  "orderBookId": "ob_abc123",
  "liquidatedUser": "0x1111111111111111111111111111111111111111",
  "amount": "10000000000000000000",
  "reason": "Collateral ratio below minimum threshold"
}

{
  "success": true,
  "data": {
    "id": "pord_liq001",
    "orderBookId": "ob_abc123",
    "liquidatedUser": "0x1111111111111111111111111111111111111111",
    "amount": "10000000000000000000",
    "reason": "Collateral ratio below minimum threshold",
    "status": "EXECUTED",
    "createdAt": "2025-01-15T10:30:00.000Z"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}