Skip to main content
GET
Order flow analysis

Authorizations

Authorization
string
header
required

Ironflow API key, format if_xxxx. Free keys at https://ironflow.sh/key. Optional on read endpoints.

Query Parameters

source
enum<string>
default:hyperliquid

Venue identifier. Defaults to hyperliquid.

Available options:
hyperliquid
market
string

Market symbol (e.g. BTC-PERP, ETH-PERP). Omit to query all markets.

Example:

"BTC-PERP"

address
string

Wallet address filter (hex string, e.g. 0xabc123).

Example:

"0xabc123def456"

from
integer<int64>

Start time as Unix milliseconds. Defaults to 24 hours ago. Clamped to tier history window. On /v1/trades and /v1/fills, the time range (to - from) is limited per tier (no key 1h, free key 6h, Explorer 24h, Builder 7d, Enterprise unlimited; without market filter 4h for all tiers). Returns QUERY_WINDOW_EXCEEDED (400) if exceeded — paginate with narrower from/to windows.

Example:

1718313600000

to
integer<int64>

End time as Unix milliseconds. Defaults to now.

Example:

1718400000000

Response

Order flow metrics per market.

data
object[]