Spin up an Ironbox
create_ironboxSpin up an Ironbox: a secure sandbox next to Hyperliquid where an agent runs and trades, with Ironflow data, analytics, alerts and execution built in. No key needed for mode paper (the default): you get a trial box, the agent's own simulated Hyperliquid account for 24 hours, with base_url and expires_at. It ends sooner after 2 hours with no requests and no strategy running. Point the Hyperliquid SDK's base_url at it, or start a strategy on it with start_box_strategy. A free key keeps a box; mode live needs a paid plan. A live box stays creating until get_ironbox shows it running.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "create_ironbox"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | paper (default) trades with simulated funds; live trades real funds | |
| name | No | Name for the Ironbox, e.g. btc-funding-bot | |
| note | No | Free text kept with the Ironbox, e.g. what the agent does | |
| size | No | small (default), medium or large | |
| markets | No | Hyperliquid markets the agent trades: perps, outcomes (HIP-4), spot | |
| runtime | No | python (default) or node |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Ironbox id (ibx_...) | |
| url | No | This Ironbox in the API | |
| mode | No | paper (simulated funds) or live | |
| name | No | Name | |
| size | No | small, medium or large | |
| paper | No | True on a paper box: the agent's own simulated Hyperliquid account | |
| state | No | creating, running, stopped, deleted or error | |
| trial | No | True on a keyless trial box | |
| notice | No | Present when the API added a note: how a market name was read, that data starts later than asked because of the history window, or a next step such as a free key | |
| region | No | Where it runs, e.g. tokyo | |
| markets | No | Markets the agent trades: perps, outcomes, spot | |
| message | No | What happens next, from the API | |
| runtime | No | python or node | |
| snippet | No | A first Python program for this box. Shown only when created or rotated | |
| base_url | No | Set the Hyperliquid SDK's base_url to this. Shown only when a paper box is created or rotated | |
| dashboard | No | Where the user manages it on ironflow.sh | |
| created_at | No | Creation time, Unix milliseconds | |
| expires_at | No | When a trial box ends at the latest, Unix milliseconds | |
| activity_url | No | Where to watch this box. Shown only with base_url | |
| strategies_url | No | Where to start strategies on this box. Shown only with base_url | |
| starting_balance_usd | No | Starting balance of a new paper box |