# Ironflow

- [Ironflow Hyperliquid API: data over REST, streams, SQL and MCP](https://docs.ironflow.sh/introduction.md): Ironflow Hyperliquid, the agent cloud: Ironbox sandboxes for trading bots, plus trades, liquidations, funding and wallets over REST, streams, SQL or MCP.
- [Authentication: keyless access and API keys](https://docs.ironflow.sh/authentication.md): Call the Ironflow Hyperliquid API without a key, get a free key by email or from code, send it as a Bearer token, and the limits of each plan.
- [Quickstart: your first Hyperliquid data request](https://docs.ironflow.sh/quickstart.md): Your first Hyperliquid data request in under 5 minutes, no key needed: call the Ironflow REST API with cURL, Python or TypeScript and page through trades.
- [Pagination](https://docs.ironflow.sh/concepts/pagination.md): How to page through large Hyperliquid result sets from the Ironflow API with cursors, and scope them with from and to time ranges.
- [Timestamps and time ranges](https://docs.ironflow.sh/concepts/timestamps.md): How the Ironflow Hyperliquid API reads times: Unix milliseconds or seconds, ISO 8601 and relative times like -7d, and how far back each plan reaches.
- [Sources & Markets](https://docs.ironflow.sh/concepts/sources-and-markets.md): Hyperliquid market classes and symbols in the Ironflow API: native perps, spot, HIP-3 builder markets and HIP-4 outcomes, and how to filter them.
- [HIP-4 outcome markets](https://docs.ironflow.sh/concepts/hip4-outcomes.md): Hyperliquid HIP-4 outcome (prediction) markets in the Ironflow API: symbol scheme, settlement, and their trades, candles, summary and history.
- [Rate limits and errors](https://docs.ironflow.sh/concepts/rate-limits.md): Ironflow Hyperliquid API limits by plan (requests, history, SQL, streams, alerts), every error code, and how to handle 429 and 402 responses.
- [Plans and payment](https://docs.ironflow.sh/concepts/plans-and-payment.md): Upgrade an Ironflow API key to a paid plan with USDC on Base or Hyperliquid, from the website or from code, or buy a plan in one call with x402.
- [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.
- [Ironbox: your own simulated Hyperliquid account](https://docs.ironflow.sh/guides/ironbox.md): Create a paper box from code: your own simulated Hyperliquid account. Your agent trades it with the official Hyperliquid SDK by setting base_url.
- [Hyperliquid RPC: your API key as an endpoint](https://docs.ironflow.sh/guides/hyperliquid-rpc.md): A Hyperliquid RPC endpoint with its own API rate limit. Change one line in the official Python SDK and read /info on your plan's limits instead of the public per-IP budget.
- [Hyperliquid liquidation alerts to Discord, Slack, Telegram or a webhook](https://docs.ironflow.sh/guides/liquidation-alerts.md): Get Hyperliquid liquidations posted to Discord, Slack, Telegram or your webhook within seconds, filtered by market, side, size and wallet. No server to run.
- [Pay per call with x402: Hyperliquid data for agents, no account](https://docs.ironflow.sh/guides/pay-per-call.md): AI agents can pay for single Ironflow API calls in USDC on Base with x402: from $0.001 a request and $0.01 a SQL query, no account or key, at Builder limits.
- [Hyperliquid datasets: free trades, liquidations, funding and candles](https://docs.ironflow.sh/guides/datasets.md): Free Hyperliquid datasets from Ironflow's nodes on Hugging Face and Kaggle: trades, liquidations, funding, hourly candles, open interest and HIP-4 outcomes.
- [Hyperliquid whale alerts: large trades to Slack or Discord](https://docs.ironflow.sh/guides/whale-alerts.md): Watch large Hyperliquid trades as they happen with the live trades stream, filter by USD size and post them to a Slack, Discord or Telegram webhook.
- [Hyperliquid funding rate monitor](https://docs.ironflow.sh/guides/funding-rate-monitor.md): Scan funding on every Hyperliquid perp in one call, pull a market's funding history and its mean and extremes, from the Ironflow API with or without a key.
- [Cohorts](https://docs.ironflow.sh/guides/cohorts.md): Track groups of addresses — predefined smart money groups or your own custom lists.
- [Hyperliquid analytics: flows, liquidation levels and map, vaults](https://docs.ironflow.sh/guides/analytics.md): Hyperliquid analytics over the Ironflow API: net flows, past liquidation levels, the forward liquidation map, vault rankings and funding stats.
- [Hyperliquid MCP server for AI agents](https://docs.ironflow.sh/guides/ai-agents.md): Connect Claude, Cursor or any MCP client to Ironflow's hosted MCP server: 54 tools for Hyperliquid trades, liquidations, wallets, SQL and alerts. No key needed.
- [Freqtrade Hyperliquid historical data](https://docs.ironflow.sh/guides/freqtrade-hyperliquid-historical-data.md): Backtest Freqtrade on Hyperliquid perps past the 5,000-candle limit: free hourly candles and funding since June 2025 with no key, and 1m to 30m with a key.
- [CCXT Hyperliquid historical candles](https://docs.ironflow.sh/guides/ccxt-hyperliquid-historical-candles.md): Fetch Hyperliquid OHLCV in CCXT past the 5,000-candle limit: point fetch_ohlcv at your Ironflow key and page through your plan's history.
- [Hummingbot Hyperliquid historical candles](https://docs.ironflow.sh/guides/hummingbot-hyperliquid-candles.md): Feed Hummingbot's Hyperliquid candles and V2 backtests past the 5,000-candle limit: one small candle feed override reads history through your Ironflow key.
- [NautilusTrader Hyperliquid backtesting data](https://docs.ironflow.sh/guides/nautilustrader-hyperliquid-backtesting-data.md): Load Hyperliquid history into a NautilusTrader catalog past the 5,000-candle limit: free hourly bars since June 2025 with no key, 1m bars with a key.
- [TypeScript SDK](https://docs.ironflow.sh/sdks/typescript.md): The @ironflowsh/sdk TypeScript client for the Ironflow Hyperliquid API, frozen at 0.6.0: setup, methods, pagination and errors.
- [Python SDK](https://docs.ironflow.sh/sdks/python.md): The ironflow-sdk Python client for the Ironflow Hyperliquid API, frozen at 0.6.0: setup, async methods, pagination and errors.
- [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.
- [Ironflow REST API reference](https://docs.ironflow.sh/api-reference/introduction.md): Reference for every Ironflow endpoint for Hyperliquid data: base URL, keyless and key access, streams, SQL, x402, the response envelope and 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 markets snapshot](https://docs.ironflow.sh/api-reference/market-data/markets-snapshot.md): GET /v1/markets/snapshot returns every Hyperliquid market in one call: price, 24h change, open interest, funding and volume, for perps, HIP-3 and spot.
- [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 or a list of markets across all participants. Every trade is stored; the history window depends on your key tier.
- [Hyperliquid order book (L2)](https://docs.ironflow.sh/api-reference/market-data/order-book.md): GET /v1/book returns the live L2 order book of one Hyperliquid market: up to 20 levels a side with size and orders, mid, spread and USD depth. No key needed.
- [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 liquidation totals by market and window](https://docs.ironflow.sh/api-reference/market-data/liquidations-summary.md): GET /v1/liquidations/summary returns long and short USD liquidated on Hyperliquid per window (15m to 7d) and market, with counts, wallets and the largest one.
- [Hyperliquid auto-deleveraging (ADL) fills](https://docs.ironflow.sh/api-reference/market-data/auto-deleveraging.md): GET /v1/adl lists Hyperliquid auto-deleveraging fills, newest first, across markets or for one. Recorded from 2026-08-01.
- [Hyperliquid liquidations live stream](https://docs.ironflow.sh/api-reference/market-data/stream-liquidations.md): GET /v1/liquidations/stream pushes Hyperliquid liquidations as they happen over Server-Sent Events, with market and size filters and resume on reconnect.
- [Hyperliquid trades live stream](https://docs.ironflow.sh/api-reference/market-data/stream-trades.md): GET /v1/trades/stream pushes Hyperliquid trades as they happen over Server-Sent Events, with market, wallet and size filters and resume on reconnect.
- [Hyperliquid OHLCV candles](https://docs.ironflow.sh/api-reference/market-data/list-candles.md): GET /v1/candles returns OHLCV candles for any Hyperliquid market from 1m to 1w, 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 open interest movers](https://docs.ironflow.sh/api-reference/market-data/open-interest-changes.md): GET /v1/open-interest/changes ranks Hyperliquid perps by how their open interest moved over 1h, 4h, 24h or 7d, in USD or percent.
- [Hyperliquid mark vs oracle premium](https://docs.ironflow.sh/api-reference/market-data/premium.md): GET /v1/premium returns a Hyperliquid perp's mark against its oracle price in basis points; on HIP-3 stock perps the oracle follows the underlying.
- [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 HIP-4 outcome markets summary](https://docs.ironflow.sh/api-reference/market-data/predictions-summary.md): GET /v1/predictions/summary returns activity on Hyperliquid's HIP-4 outcome markets: traded volume, fills, wallets, an hourly series and the active markets.
- [Hyperliquid HIP-4 outcome volume by month](https://docs.ironflow.sh/api-reference/market-data/predictions-history.md): GET /v1/predictions/history returns traded volume on Hyperliquid's HIP-4 outcome markets by calendar month since August 2026, plus the last 7 days.
- [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. Works without a key.
- [Hyperliquid liquidations by price level](https://docs.ironflow.sh/api-reference/analytics/liquidation-levels.md): GET /v1/analytics/liquidation-levels buckets past Hyperliquid liquidations by price and side, for heatmaps of where longs and shorts were closed.
- [Hyperliquid liquidation map](https://docs.ironflow.sh/api-reference/analytics/liquidation-map.md): GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node's state snapshot.
- [Markets in the Hyperliquid liquidation map](https://docs.ironflow.sh/api-reference/analytics/liquidation-map-markets.md): GET /v1/liquidations/map/markets lists every Hyperliquid perp in the liquidation map with its mark and long and short notional at risk. No key needed.
- [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. Without a key, the top 10 vaults of the last 24 hours.
- [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. Works without a key.
- [Hyperliquid PnL leaderboard](https://docs.ironflow.sh/api-reference/analytics/leaderboard-pnl.md): GET /v1/analytics/leaderboard-pnl ranks every Hyperliquid wallet by realized PnL, biggest losses or volume over a window.
- [Top wallets in a Hyperliquid market](https://docs.ironflow.sh/api-reference/analytics/market-top-wallets.md): GET /v1/analytics/market-top-wallets ranks the wallets trading one Hyperliquid market by volume or PnL over a window.
- [Hyperliquid wallet labels](https://docs.ironflow.sh/api-reference/analytics/wallet-labels.md): GET /v1/analytics/wallet-labels returns precomputed Hyperliquid wallet labels: whales, smart money, vaults and vault leaders.
- [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 wallet activity summary](https://docs.ironflow.sh/api-reference/analytics/user-summary.md): GET /v1/analytics/user-summary returns a Hyperliquid wallet's activity in one call: volume, realized PnL, fills, win rate, maker and taker mix, markets.
- [Hyperliquid wallet PnL over time](https://docs.ironflow.sh/api-reference/analytics/user-pnl-series.md): GET /v1/analytics/user-pnl-series returns a Hyperliquid wallet's realized PnL as a time series, per bucket and cumulative.
- [Hyperliquid wallet positions at a past time](https://docs.ironflow.sh/api-reference/analytics/positions-at.md): GET /v1/positions returns the exact perp positions a Hyperliquid wallet held at a past moment, up to 90 days back, with mark price and notional at that time.
- [Hyperliquid funding payments by address](https://docs.ironflow.sh/api-reference/analytics/user-funding.md): GET /v1/analytics/user-funding returns a Hyperliquid address's funding payments per market and day or hour, from Hyperliquid's ledger, native and HIP-3.
- [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.
- [Run read-only SQL on Hyperliquid data](https://docs.ironflow.sh/api-reference/query/run-query.md): POST /v1/query runs read-only ClickHouse SQL over Ironflow's Hyperliquid tables: fills, trades, liquidations, funding, wallets. Works without a key.
- [Run Hyperliquid SQL from a URL](https://docs.ironflow.sh/api-reference/query/run-query-get.md): GET /v1/query?sql= runs the same read-only Hyperliquid SQL from a URL, for clients that can only fetch URLs. Works without a key.
- [Export SQL results as Parquet or CSV](https://docs.ironflow.sh/api-reference/query/export.md): POST /v1/query/export runs read-only SQL over Ironflow's Hyperliquid tables and returns a Parquet or CSV file, on Explorer and Builder plans.
- [Hyperliquid SQL tables and columns](https://docs.ironflow.sh/api-reference/query/schema.md): GET /v1/query/schema lists the hl.* tables you can query with SQL, their columns, how far back each goes, example queries and your tier's limits.
- [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.
- [List your liquidation alerts](https://docs.ironflow.sh/api-reference/alerts/list-alerts.md): GET /v1/alerts lists the liquidation alerts on your account, with where each posts, its filter, delivery state and how many your tier allows.
- [Create a Hyperliquid liquidation alert](https://docs.ironflow.sh/api-reference/alerts/create-alert.md): POST /v1/alerts posts matching Hyperliquid liquidations to your webhook, Discord, Slack or Telegram within seconds, filtered by market, side, size and wallet.
- [Delete a liquidation alert](https://docs.ironflow.sh/api-reference/alerts/delete-alert.md): DELETE /v1/alerts/{id} stops and removes one of your liquidation alerts.
- [Send a test liquidation alert](https://docs.ironflow.sh/api-reference/alerts/test-alert.md): POST /v1/alerts/{id}/test sends a sample liquidation to an alert's destination now and reports whether it arrived; a delivered test re-enables the alert.
- [Create an Ironbox](https://docs.ironflow.sh/api-reference/ironbox/create-ironbox.md): POST /v1/ironbox creates a paper box, your own simulated Hyperliquid account with live prices that never places a real order.
- [List your Ironboxes](https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes.md): GET /v1/ironbox lists the calling key's Ironboxes, newest first.
- [Get an Ironbox](https://docs.ironflow.sh/api-reference/ironbox/get-ironbox.md): GET /v1/ironbox/{id} returns one of your Ironboxes and its state.
- [Delete an Ironbox](https://docs.ironflow.sh/api-reference/ironbox/delete-ironbox.md): DELETE /v1/ironbox/{id} deletes one of your Ironboxes and returns it in state deleted.
- [Reset a paper box](https://docs.ironflow.sh/api-reference/ironbox/reset-ironbox.md): POST /v1/ironbox/{id}/reset restores the starting balance and clears positions, orders and fills.
- [Rotate a paper box URL](https://docs.ironflow.sh/api-reference/ironbox/rotate-ironbox.md): POST /v1/ironbox/{id}/rotate gives a paper box a new URL, shown once.
- [Get a paper box's report](https://docs.ironflow.sh/api-reference/ironbox/promote-ironbox.md): POST /v1/ironbox/{id}/promote reports how a paper box did: orders, fills, fees, funding, equity and drawdown. It never changes the box.
- [Request a free Hyperliquid API key](https://docs.ironflow.sh/api-reference/billing/request-key.md): POST /v1/keys emails a free Ironflow API key: 60 requests per minute and 14 days of Hyperliquid history. No card.
- [Ironflow API plans and prices](https://docs.ironflow.sh/api-reference/billing/list-plans.md): GET /v1/billing/plans lists the paid plans, their limits and prices in USDC, and how to pay from code on Base or Hyperliquid, or in one call with x402.
- [Upgrade an API key with USDC on Base or Hyperliquid](https://docs.ironflow.sh/api-reference/billing/request-upgrade.md): POST /v1/billing/upgrade opens a plan upgrade for an API key: send the USDC on Base or Hyperliquid from your wallet and the plan starts within a minute.
- [Upgrade request status](https://docs.ironflow.sh/api-reference/billing/upgrade-status.md): GET /v1/billing/upgrade returns an upgrade request's status, pending, paid or expired, with the transfers seen and when the plan ends.
- [Buy an Ironflow plan with x402](https://docs.ironflow.sh/api-reference/billing/buy-plan-x402.md): POST /x402/v1/plans/{plan}/buy buys a 30-day API plan in one call with x402, USDC on Base, no account. The plan starts once the payment settles.
- [Ironflow API index](https://docs.ironflow.sh/api-reference/system/index.md): GET /v1 lists the main Ironflow Hyperliquid data endpoints with links to the docs, the OpenAPI spec, the MCP server and x402 discovery.
- [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.
- [Ironflow API performance metrics](https://docs.ironflow.sh/api-reference/system/metrics.md): GET /v1/status/metrics returns rolling performance metrics for the Ironflow API: error rate and request latency percentiles over 5 minutes, plus probe samples.

## OpenAPI Specs

- [openapi](/openapi.yaml)


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