# Ironflow

- [Ironflow API: Hyperliquid market data over REST](https://docs.ironflow.sh/introduction.md): Hyperliquid market data over REST: tick-level fills and trades, candles, funding, open interest, mark prices and wallet analytics, with a year of fill history.
- [Authentication](https://docs.ironflow.sh/authentication.md): API keys and how to use them.
- [Quickstart: your first Hyperliquid data request](https://docs.ironflow.sh/quickstart.md): Make your first Ironflow API request in under 5 minutes: get a key, call the REST API with cURL, Python or TypeScript, and page through Hyperliquid trades.
- [Pagination](https://docs.ironflow.sh/concepts/pagination.md): Fetching large datasets with cursor-based pagination.
- [Timestamps](https://docs.ironflow.sh/concepts/timestamps.md): How timestamps work in the Ironflow API.
- [Sources & Markets](https://docs.ironflow.sh/concepts/sources-and-markets.md): Hyperliquid market classes and symbol schemes.
- [HIP-4 Outcome Contracts](https://docs.ironflow.sh/concepts/hip4-outcomes.md): Binary prediction markets on Hyperliquid — symbol scheme, settlement model, and how to query them with Ironflow.
- [Rate Limits & Errors](https://docs.ironflow.sh/concepts/rate-limits.md): Rate limits, error codes, and how to handle them.
- [Data Methodology](https://docs.ironflow.sh/concepts/data-methodology.md): How Ironflow stores, normalizes, and exposes every event type — straight from the venue, with the methodology choices spelled out.
- [Reliability](https://docs.ironflow.sh/concepts/reliability.md): How Ironflow detects, prevents, and recovers from data-quality regressions.
- [Whale Alerts](https://docs.ironflow.sh/guides/whale-alerts.md): Detect large trades on any Hyperliquid market and pipe them to Slack or Discord.
- [Funding Rate Monitor](https://docs.ironflow.sh/guides/funding-rate-monitor.md): Track funding across every Hyperliquid perp and catch rate divergences.
- [Cohorts](https://docs.ironflow.sh/guides/cohorts.md): Track groups of addresses — predefined smart money groups or your own custom lists.
- [Analytics](https://docs.ironflow.sh/guides/analytics.md): Aggregated market intelligence — net flows, liquidation heatmaps, order flow, vault rankings.
- [Hyperliquid MCP server for AI agents](https://docs.ironflow.sh/guides/ai-agents.md): Connect Claude, Cursor or any MCP client to the hosted Ironflow MCP server for Hyperliquid fills, funding, wallets and read-only SQL. No install, no key needed.
- [TWAP and Iceberg](https://docs.ironflow.sh/guides/execution-twap-iceberg.md): Work a large order in the Ironflow terminal, over time or at your price, and review how it filled with the API.
- [TypeScript SDK](https://docs.ironflow.sh/sdks/typescript.md): Official TypeScript/Node.js SDK for the Ironflow API.
- [Python SDK](https://docs.ironflow.sh/sdks/python.md): Official Python SDK for the Ironflow API.
- [Ironflow REST API reference](https://docs.ironflow.sh/api-reference/introduction.md): Reference for every Ironflow REST endpoint for Hyperliquid data: base URL, bearer key authentication, the shared response envelope and cursor pagination.
- [List Hyperliquid markets](https://docs.ironflow.sh/api-reference/market-data/list-markets.md): GET /v1/markets returns every active Hyperliquid market: native perps, HIP-3 builder markets, HIP-4 outcomes and spot, with the symbols other endpoints accept.
- [Hyperliquid trade history](https://docs.ironflow.sh/api-reference/market-data/list-trades.md): GET /v1/trades returns tick-level Hyperliquid trades for one market across all participants. Every trade is stored; the history window depends on your key tier.
- [Hyperliquid fills by address](https://docs.ironflow.sh/api-reference/market-data/list-fills.md): GET /v1/fills returns the fills of one Hyperliquid address with maker or taker role, realized PnL and the fee paid per fill, filtered by market and time range.
- [Hyperliquid liquidation history](https://docs.ironflow.sh/api-reference/market-data/list-liquidations.md): GET /v1/liquidations returns historical Hyperliquid liquidation events, detected from the fill events themselves rather than a heuristic, for every market.
- [Hyperliquid OHLCV candles](https://docs.ironflow.sh/api-reference/market-data/list-candles.md): GET /v1/candles returns OHLCV candles for any Hyperliquid market at 1m, 5m, 15m, 1h, 4h or 1d intervals, built from raw trades with a buy and sell volume split.
- [Hyperliquid funding rate history](https://docs.ironflow.sh/api-reference/market-data/list-funding-rates.md): GET /v1/funding returns historical hourly funding rate snapshots for Hyperliquid perps, native and HIP-3 builder markets. Negative rates mean shorts pay longs.
- [Hyperliquid open interest history](https://docs.ironflow.sh/api-reference/market-data/list-open-interest.md): GET /v1/open-interest returns Hyperliquid open interest snapshots at 10-second resolution, with 24-hour trading volume alongside each snapshot for every market.
- [Hyperliquid mark and oracle prices](https://docs.ironflow.sh/api-reference/market-data/list-mark-prices.md): GET /v1/mark-prices returns Hyperliquid mark price and oracle price snapshots at 10-second resolution, with the funding rate at each snapshot for every perp.
- [Hyperliquid vault deposits and withdrawals](https://docs.ironflow.sh/api-reference/market-data/list-vault-operations.md): GET /v1/vault-operations returns Hyperliquid vault deposit and withdrawal events, filtered by vault address, depositor address or both, over a time range.
- [Hyperliquid net deposit and withdrawal flows](https://docs.ironflow.sh/api-reference/analytics/net-flows.md): GET /v1/analytics/net-flows returns Hyperliquid deposits minus withdrawals per time bucket, showing capital moving in and out. Builder tier or above required.
- [Hyperliquid liquidations by price level](https://docs.ironflow.sh/api-reference/analytics/liquidation-levels.md): GET /v1/analytics/liquidation-levels buckets Hyperliquid liquidations by price, for heatmaps of where positions were closed. Requires the Builder tier or above.
- [Hyperliquid order flow analysis](https://docs.ironflow.sh/api-reference/analytics/order-flow.md): GET /v1/analytics/order-flow returns fill and cancel rates per Hyperliquid market as a measure of execution quality. Requires the Builder tier or above.
- [Hyperliquid vault leaderboard](https://docs.ironflow.sh/api-reference/analytics/vault-leaderboard.md): GET /v1/analytics/vault-leaderboard ranks Hyperliquid vaults by net deposits to show which vaults are attracting capital. Requires the Builder tier or above.
- [Hyperliquid funding rate statistics](https://docs.ironflow.sh/api-reference/analytics/funding-stats.md): GET /v1/analytics/funding-stats returns Hyperliquid funding rate statistics over time, including annualized rates per market. Builder tier or above required.
- [Hyperliquid open positions and unrealized PnL](https://docs.ironflow.sh/api-reference/analytics/user-state.md): GET /v1/analytics/user-state returns an address's open Hyperliquid perp positions, entry and mark prices and unrealized PnL, in the clearinghouseState shape.
- [Hyperliquid funding payments by address](https://docs.ironflow.sh/api-reference/analytics/user-funding.md): GET /v1/analytics/user-funding returns daily or hourly funding payments per market for a Hyperliquid address, taken from Hyperliquid's own userFunding ledger.
- [Hyperliquid maker and taker breakdown by address](https://docs.ironflow.sh/api-reference/analytics/user-maker-taker.md): GET /v1/analytics/user-maker-taker splits a Hyperliquid address's fills, notional and fees into maker and taker per market over a time window, rebates included.
- [Hyperliquid deposits, withdrawals and ledger events](https://docs.ironflow.sh/api-reference/analytics/user-ledger.md): GET /v1/analytics/user-ledger returns non-fill ledger events for a Hyperliquid address: deposits, withdrawals, vault operations, transfers and staking.
- [List Hyperliquid wallet cohorts](https://docs.ironflow.sh/api-reference/cohorts/list-cohorts.md): GET /v1/cohorts lists the six predefined Hyperliquid wallet cohorts, such as top 30-day PnL and whale fills, plus any custom cohorts owned by your API key.
- [Create a custom wallet cohort](https://docs.ironflow.sh/api-reference/cohorts/create-cohort.md): POST /v1/cohorts creates a custom cohort of up to 10,000 Hyperliquid addresses that you can query as a group. Custom cohorts require the Enterprise tier.
- [Get the addresses in a wallet cohort](https://docs.ironflow.sh/api-reference/cohorts/get-cohort-addresses.md): GET /v1/cohorts/{name} returns every Hyperliquid address in a cohort. Predefined cohorts are recomputed every 30 minutes and served from cache between runs.
- [Delete a custom wallet cohort](https://docs.ironflow.sh/api-reference/cohorts/delete-cohort.md): DELETE /v1/cohorts/{name} removes a custom wallet cohort owned by your API key. The six predefined Hyperliquid cohorts are shared and cannot be deleted.
- [Ironflow API status](https://docs.ironflow.sh/api-reference/system/status.md): GET /v1/status returns overall health, per-venue data freshness and platform totals for the Ironflow Hyperliquid data API. It needs no API key.
- [Ironflow API uptime history](https://docs.ironflow.sh/api-reference/system/history.md): GET /v1/status/history returns an hourly uptime timeline for the Ironflow API: 24 buckets for 24h or 168 for 7d, each with the worst status seen in that hour.
- [Ironflow API health check](https://docs.ironflow.sh/api-reference/system/health.md): GET /healthz is the load balancer health check for the Ironflow Hyperliquid data API. It returns HTTP 200 while the server is up and needs no API key.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.