{"start_here":{"paper_box":{"what":"Your own simulated Hyperliquid account. No key, one call. The answer has base_url, strategies_url and activity_url.","call":"POST https://api.ironflow.sh/v1/ironbox"},"strategy":{"what":"Run a strategy on the box around the clock with no client connected: breakout, grid or dca, each with a max_loss_usd guard. Paper only.","call":"POST {base_url}/strategies","body":"{\"kind\":\"dca\",\"market\":\"BTC\",\"tranche_usd\":100,\"budget_usd\":500,\"max_loss_usd\":100}"},"watch":{"what":"Watch what it does: decisions with reasons, orders, fills, funding, stops, plus equity and PnL. Poll with after=\u003cnext_cursor\u003e.","call":"GET {base_url}/activity"},"guide":"https://docs.ironflow.sh/guides/ironbox"},"name":"Ironflow API","about":"Hyperliquid market data from our own nodes: trades, liquidations, funding, open interest, candles, wallet analytics and SQL. No key needed to start.","endpoints":{"DELETE /box/{secret}/strategies/{id}":"stop a strategy; add ?close_position=false to leave its position open","GET /box/{secret}/activity":"what a paper box and its strategies did, with a cursor (?after=)","GET /box/{secret}/strategies":"list a paper box's strategies","GET /v1/analytics/leaderboard-pnl":"top traders by realized PnL","GET /v1/analytics/liquidation-levels":"liquidations by price level","GET /v1/analytics/user-state":"a wallet's open positions","GET /v1/book":"live L2 order book of a market","GET /v1/candles":"OHLCV candles, 1m to 1w","GET /v1/funding":"funding rate history","GET /v1/liquidations":"liquidations, newest first; poll with after=","GET /v1/liquidations/map":"where open positions would be liquidated, by price","GET /v1/liquidations/stream":"liquidations as they happen (SSE)","GET /v1/liquidations/summary":"long and short USD liquidated per window and market","GET /v1/markets":"market list and names","GET /v1/markets/snapshot":"every market: price, open interest, funding, volume","GET /v1/open-interest":"open interest; /v1/open-interest/changes ranks movers","GET /v1/trades":"every trade (fill) for a market or wallet","POST /box/{secret}/promote":"how the paper account did and what going live would take; never changes the box","POST /box/{secret}/strategies":"start a strategy on a paper box (authorised by the box secret, so a trial box can use it)","POST /v1/alerts":"liquidation alerts to Discord, Slack, Telegram or a webhook","POST /v1/ironbox":"your own simulated Hyperliquid account (no key needed for a 24-hour trial) or a live Ironbox","POST /v1/query":"read-only SQL over the hl.* tables (GET /v1/query/schema lists them)"},"docs":"https://docs.ironflow.sh","openapi":"https://docs.ironflow.sh/openapi.yaml","status":"https://api.ironflow.sh/v1/status","mcp":"https://mcp.ironflow.sh/mcp","free_key":"https://ironflow.sh/key?utm_source=api_root","try":"https://api.ironflow.sh/v1/liquidations/summary","x402":"https://api.ironflow.sh/openapi.json"}