Ironflow quickstart for agents
https://ironflow.sh/start.txt

Ironflow is the agent cloud for Hyperliquid. Boot a paper box in one call,
trade it on paper with the official Hyperliquid SDK, then read its paper
report. Everything below is the same call a person makes.


1. BOOT A PAPER BOX. No key, no signup.

   curl -X POST https://api.ironflow.sh/v1/ironbox

   or in Python:

   import requests
   print(requests.post("https://api.ironflow.sh/v1/ironbox", timeout=30).json())

   Answer, 201:

   {
     "id": "ibx_3f9a0c7e12d4",
     "state": "running",
     "mode": "paper",
     "trial": true,
     "base_url": "https://api.ironflow.sh/box/ibxs_...",
     "starting_balance_usd": 10000,
     "expires_at": 1762606400000,
     "snippet": "..."
   }

   base_url is shown once. Treat it like a password: anyone with it can trade
   this box, and only this box. snippet is working Python for this box.

   A keyless box is a trial: free limits, removed after 24 hours with its
   orders and fills. 3 at once and 10 a day per IP, within a
   service-wide limit. 429 IRONBOX_LIMIT or IRONBOX_CAPACITY: wait for
   Retry-After, or use a free key (step 3).


2. TRADE IT. The official Hyperliquid SDK, only base_url changes.

   pip install hyperliquid-python-sdk

   import hashlib

   from eth_account import Account
   from hyperliquid.exchange import Exchange
   from hyperliquid.info import Info

   BASE_URL = "https://api.ironflow.sh/box/ibxs_..."  # base_url from step 1

   # A box binds to its first signer, so derive the same throwaway wallet
   # every run. Never use a funded key here.
   wallet = Account.from_key(hashlib.sha256(BASE_URL.encode()).digest())
   info = Info(BASE_URL, skip_ws=True)  # a paper box has no WebSocket
   exchange = Exchange(wallet, base_url=BASE_URL)

   print(exchange.market_open("BTC", True, 0.001))
   print(info.user_state(wallet.address))

   Main perp markets, $10,000 simulated, live prices. Every answer has
   "paper": true or the X-Ironflow-Paper header.


3. KEEP A BOX. A free key, one email, no card.

   curl -X POST https://api.ironflow.sh/v1/keys \
     -H "Content-Type: application/json" \
     -d '{"email": "you@example.com"}'

   The key arrives by email. Boxes made with a key stay (3 paper boxes on
   Free, 5 on Explorer, 10 on Builder, 25 on Enterprise).

   curl -X POST https://api.ironflow.sh/v1/ironbox \
     -H "Authorization: Bearer if_your_key" \
     -H "Content-Type: application/json" \
     -d '{"name": "my-agent", "mode": "paper"}'

   GET /v1/ironbox/{id} shows equity, profit, fees, funding, positions and
   fills. POST /v1/ironbox/{id}/reset restores the starting balance. These
   need a box made with a key: a trial box has no owner.


4. PAPER REPORT. When the agent is ready.

   curl -X POST https://api.ironflow.sh/v1/ironbox/ibx_.../promote \
     -H "Authorization: Bearer if_your_key"

   Needs the key that owns a paper box. Answers with the paper report (days
   active, orders, fills, fees, funding, equity, max drawdown, rejected
   orders, data gaps). Read promoted and message in the answer:
   the box stays paper. Ironbox is paper only and never places a real order.


5. USE THE STACK. Data, analytics, alerts, MCP and x402, with or without a box.

   Data, no key:
   curl "https://api.ironflow.sh/v1/trades?market=BTC-PERP&limit=5"

   MCP, 54 tools, no key to read:
   https://mcp.ironflow.sh/mcp
   claude mcp add --transport http ironflow https://mcp.ironflow.sh/mcp

   x402 pay-per-call, USDC on Base, from $0.001, no account:
   https://docs.ironflow.sh/guides/pay-per-call

   Plans, 30 days at a time in USDC on Hyperliquid, no card: GET
   https://api.ironflow.sh/v1/billing/plans


MORE

   Full reference        https://ironflow.sh/llms.txt
   Current facts         https://ironflow.sh/facts.md
   Docs as one file      https://docs.ironflow.sh/llms-full.txt
   Guides as one file    https://ironflow.sh/guides-full.txt
   OpenAPI               https://docs.ironflow.sh/openapi.yaml
   Pay-per-call OpenAPI  https://api.ironflow.sh/openapi.json
   API catalog           https://ironflow.sh/.well-known/api-catalog
   MCP catalog           https://ironflow.sh/.well-known/ai-catalog.json
   Ironbox guide         https://docs.ironflow.sh/guides/ironbox
   Status                https://status.ironflow.sh


PAGES

   Free key              https://ironflow.sh/key
   Liquidation map       https://ironflow.sh/liquidations/map
   Top traders           https://ironflow.sh/top-traders
   Historical data       https://ironflow.sh/guides/hyperliquid-historical-data
   Liquidation data      https://ironflow.sh/guides/hyperliquid-liquidation-data
   Candles               https://ironflow.sh/guides/hyperliquid-candles-ohlcv
   Datasets              https://ironflow.sh/datasets


GUIDES, NEW

   Hyperliquid API key   https://ironflow.sh/guides/hyperliquid-api-key
   Leaderboard API       https://ironflow.sh/guides/hyperliquid-leaderboard-api
   Mark price            https://ironflow.sh/guides/hyperliquid-mark-price
   Server location       https://ironflow.sh/guides/hyperliquid-server-location
   Backtest in English   https://ironflow.sh/guides/hyperliquid-backtest-plain-english
   Funding rate spike    https://ironflow.sh/guides/hyperliquid-funding-rate-spike
   Agent sandbox         https://ironflow.sh/guides/hyperliquid-trading-agent-sandbox
   All guides            https://ironflow.sh/guides