Get HIP-3 trades - 0xArchive

{ "success": true, "data": [ { "symbol": "BTC", "coin": "BTC", "side": "B", "price": "42150.50", "size": "0.5", "timestamp": "2025-01-21T10:30:45.123Z", "tx_hash": "<string>", "trade_id": 123, "order_id": 123, "crossed": true, "fee": "<string>", "fee_token": "<string>", "closed_pnl": "<string>", "direction": "<string>", "start_position": "<string>", "user_address": "<string>", "maker_address": "<string>", "taker_address": "<string>", "builder_address": "<string>", "builder_fee": "<string>", "deployer_fee": "<string>", "priority_gas": 123, "cloid": "<string>", "twap_id": 123 } ], "meta": { "count": 123, "next_cursor": "<string>", "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } }

Authorizations

X-API-Key

string

header

required

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

Path Parameters

symbol

string

required

Trading pair symbol (e.g., km:US500, xyz:XYZ100). HIP-3 symbols are case-sensitive.

Example:

"xyz:XYZ100"

Query Parameters

start

integer<int64>

Start timestamp in Unix milliseconds. Defaults to 24h ago.

end

integer<int64>

End timestamp in Unix milliseconds. Defaults to now.

cursor

string

Cursor for pagination

limit

integer

default:100

Maximum number of results (default: 100, max: 1000)

Required range: x <= 1000

Response

List of trades with cursor for next page

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.side

enum<string>

required

Trade side: 'B' (buy) or 'A' (sell/ask)

Available options:

A,

B

Example:

"B"

data.price

string

required

Execution price

Example:

"42150.50"

data.size

string

required

Trade size

Example:

"0.5"

data.timestamp

string<date-time>

required

Execution timestamp (UTC)

Example:

"2025-01-21T10:30:45.123Z"

data.tx_hash

string | null

Blockchain transaction hash

data.trade_id

integer<int64> | null

Unique trade ID

data.order_id

integer<int64> | null

Associated order ID

data.crossed

boolean | null

True if taker (crossed the spread), false if maker

data.fee

string | null

Trading fee amount

data.fee_token

string | null

Fee denomination (e.g., USDC)

data.closed_pnl

string | null

Realized PnL if closing a position

data.direction

string | null

Position direction (e.g., 'Open Long', 'Close Short', 'Long > Short')

data.start_position

string | null

Position size before this trade

data.user_address

string | null

User's wallet address

data.maker_address

string | null

Maker's wallet address (the resting order)

data.taker_address

string | null

Taker's wallet address (crossed the spread)

data.builder_address

string | null

Builder address that routed this order. Present only when the order was placed through a builder.

data.builder_fee

string | null

Builder fee charged on this fill, paid to the builder (in quote currency, typically USDC). Present only when builder_address is set.

data.deployer_fee

string | null

HIP-3 deployer fee share on this fill (in quote currency). Negative for the maker side (rebate), positive for the taker side. Present only on HIP-3 fills.

data.priority_gas

number | null

Priority fee burned in HYPE (not USDC) for write priority on the Hyperliquid validator queue. Independent of builder_fee and deployer_fee — paid to the network, not to a builder or deployer. Present only when the order paid for priority.

data.cloid

string | null

Client order ID

data.twap_id

integer | null

TWAP execution ID