Ironbox: run a trading agent next to Hyperliquid

An Ironbox is a secure, sandboxed environment in Tokyo, next to Hyperliquid, where your trading agent runs with Ironflow’s API, data, analytics, alerts and execution on the box. Perps, prediction markets and spot.

1. Get a key

Any key works, a free one included. From code:

curl -X POST https://api.ironflow.sh/v1/keys \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

The key arrives by email. Or get one at ironflow.sh/key.

2. Create an Ironbox

curl -X POST https://api.ironflow.sh/v1/ironbox \
  -H "Authorization: Bearer if_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "grid-bot", "mode": "paper", "runtime": "python", "markets": ["perps"]}'

import requests

API = "https://api.ironflow.sh/v1/ironbox"
HEADERS = {"Authorization": "Bearer if_your_key"}

box = requests.post(API, headers=HEADERS, json={
    "name": "grid-bot",
    "mode": "paper",
    "runtime": "python",
    "markets": ["perps"],
}).json()
print(box["id"], box["state"])

{
  "id": "ibx_3f9a0c7e12d4",
  "name": "grid-bot",
  "state": "creating",
  "size": "small",
  "mode": "paper",
  "runtime": "python",
  "markets": ["perps"],
  "region": "tokyo",
  "created_at": 1762520000000,
  "url": "https://api.ironflow.sh/v1/ironbox/ibx_3f9a0c7e12d4",
  "dashboard": "https://ironflow.sh/ironbox",
  "message": "Your Ironbox is being set up. We email you when it is ready."
}

Every field is optional:

Field	Values	Default
`name`	Up to 64 characters	none
`size`	`small`, `medium`, `large`	`small`
`mode`	`paper`, `live`	`paper`
`runtime`	`python`, `node`	`python`
`markets`	Any of `perps`, `outcomes`, `spot`	`["perps"]`
`note`	Up to 500 characters: your strategy, markets, volume	none

A key can have 3 Ironboxes at a time.

3. Poll its state

curl https://api.ironflow.sh/v1/ironbox/ibx_3f9a0c7e12d4 \
  -H "Authorization: Bearer if_your_key"

import time

while box["state"] == "creating":
    time.sleep(30)
    box = requests.get(box["url"], headers=HEADERS).json()
print(box["state"], box["message"])

States: creating, running, stopped, deleted, error. We email you when the box is ready. GET /v1/ironbox lists your boxes, newest first.

4. Delete it

curl -X DELETE https://api.ironflow.sh/v1/ironbox/ibx_3f9a0c7e12d4 \
  -H "Authorization: Bearer if_your_key"

requests.delete(box["url"], headers=HEADERS)

The answer is the box in state deleted.

Errors

Status	Code	Meaning
400	`INVALID_PARAMETER`	A value is not allowed; the message names the allowed ones
401	`UNAUTHORIZED`, `KEY_REQUIRED`	No key; the message says how to get a free one
404	`NOT_FOUND`	No Ironbox with that id on this key
429	`IRONBOX_LIMIT`	The key has 3 Ironboxes; delete one first

Getting Started

Concepts

Guides

SDKs

Terminal

Ironbox: run a trading agent next to Hyperliquid

1. Get a key

2. Create an Ironbox

3. Poll its state

4. Delete it

Errors

​1. Get a key

​2. Create an Ironbox

​3. Poll its state

​4. Delete it

​Errors

1. Get a key

2. Create an Ironbox

3. Poll its state

4. Delete it

Errors