Get HIP-3 liquidation events

{ "success": true, "data": [ { "symbol": "BTC", "coin": "BTC", "timestamp": "2025-05-21T10:30:00.000Z", "liquidated_user": "0x84eec0068b37919cc8f13d7454073ac167374cc0", "liquidator_user": "0x4d969e59b312970cc07af266938a4433ccae0b4c", "price": "42500.50", "size": "1.5", "side": "B", "mark_price": "42480.25", "closed_pnl": "-1250.50", "direction": "Close Long", "trade_id": 1234567890, "tx_hash": "0xe266d353038e679c5d7e042433054f0000e1d8e52f7860ecda84573b9b5a02ca" } ], "meta": { "count": 123, "next_cursor": "<string>" } }

Authorizations

X-API-Key

string

header

required

API key for authentication. Get yours at https://0xarchive.io/dashboard

Path Parameters

symbol

string

required

HIP-3 trading pair symbol (e.g., hyna:BTC, km:US500). Case-sensitive.

Example:

"hyna:BTC"

Query Parameters

start

integer<int64>

required

Start timestamp (Unix milliseconds)

Example:

1769922000000

end

integer<int64>

End timestamp (Unix milliseconds). Defaults to now.

cursor

string

Pagination cursor (format: {timestamp_ms}_{trade_id})

limit

integer

default:1000

Maximum records to return (1-1000)

Required range: x <= 1000

Response

Liquidation events

API response containing an array of liquidation events

success

boolean

Example:

true

data

object[]

Hide child attributes

data.symbol

string

required

Trading pair symbol

Example:

"BTC"

data.coin

string

required

deprecated

Trading pair symbol (deprecated, use symbol instead)

Example:

"BTC"

data.timestamp

string<date-time>

required

Liquidation timestamp (UTC)

Example:

"2025-05-21T10:30:00.000Z"

data.liquidated_user

string

required

Address of the user who was liquidated

Example:

"0x84eec0068b37919cc8f13d7454073ac167374cc0"

data.liquidator_user

string

required

Address of the liquidator (counterparty)

Example:

"0x4d969e59b312970cc07af266938a4433ccae0b4c"

data.price

string

required

Price at which the liquidation was executed

Example:

"42500.50"

data.size

string

required

Size of the liquidated position

Example:

"1.5"

data.side

string

required

Exchange side code for the liquidation-related fill (A/B). Use direction for close/open interpretation, especially on HIP-3.

Example:

"B"

data.mark_price

string | null

Mark price at time of liquidation

Example:

"42480.25"

data.closed_pnl

string | null

Realized PnL from the liquidation (usually negative)

Example:

"-1250.50"

data.direction

string | null

Upstream direction label (for example Close Long, Close Short; HIP-3 can also emit Open Long, Open Short, or rare unclassified values such as Long > Short)

Example:

"Close Long"

data.trade_id

integer<int64> | null

Trade ID for this liquidation

Example:

1234567890

data.tx_hash

string | null

Blockchain transaction hash

Example:

"0xe266d353038e679c5d7e042433054f0000e1d8e52f7860ecda84573b9b5a02ca"