Large Liquidation Orders - Surf API Documentation

{ "data": [ { "base_asset": "<string>", "exchange": "<string>", "price": 123, "side": "<string>", "symbol": "<string>", "timestamp": 123, "usd_value": 123 } ], "meta": { "cached": true, "credits_used": 123 }, "$schema": "<string>" }

Query Parameters

exchange

enum<string>

default:Binance

Exchange name. Can be Binance, OKX, Bybit, Bitget, Hyperliquid, Gate, HTX, Bitmex, Bitfinex, CoinEx, Aster, or Lighter.

Available options:

Binance,

OKX,

Bybit,

Bitget,

Hyperliquid,

Gate,

HTX,

Bitmex,

Bitfinex,

CoinEx,

Aster,

Lighter

Example:

"Binance"

symbol

string

default:BTC

Token ticker symbol like BTC or ETH

Example:

"BTC"

min_amount

string

default:10000

Minimum liquidation amount in USD

Example:

"10000"

side

enum<string>

Filter by liquidation side. Omit to return both.

Available options:

long,

short

Example:

"long"

sort_by

enum<string>

default:timestamp

Field to sort results by

Available options:

usd_value,

timestamp,

price

order

enum<string>

default:desc

Sort order

Available options:

asc,

desc

from

string

Start of time range. Accepts Unix seconds (1704067200) or date string (2024-01-01)

Example:

"2024-01-01"

string

End of time range. Accepts Unix seconds (1706745600) or date string (2024-02-01)

Example:

"2024-02-01"

Response

data

object[] | null

required

Show child attributes

Documentation Index

Query Parameters

Response