Skip to main content
POST
Create an Ironbox
See the Ironbox guide for the full flow in curl and Python.

Authorizations

Authorization
string
header
required

Ironflow API key, format if_xxxx. Free keys at https://ironflow.sh/key. Optional on read endpoints.

Body

application/json
name
string

Your name for the box.

Maximum string length: 64
Example:

"grid-bot"

size
enum<string>
default:small
Available options:
small,
medium,
large
mode
enum<string>
default:paper

paper trades on paper, live on Hyperliquid.

Available options:
paper,
live
runtime
enum<string>
default:python
Available options:
python,
node
markets
enum<string>[]

What the agent trades: perps (native and HIP-3), outcomes (HIP-4 prediction markets), spot.

Available options:
perps,
outcomes,
spot
note
string

Anything we should know: strategy, markets, volume.

Maximum string length: 500

Response

The Ironbox, in state creating.

id
string
required
Pattern: ^ibx_[0-9a-f]{12}$
Example:

"ibx_3f9a0c7e12d4"

name
string
required

Empty when none was given.

Example:

"grid-bot"

state
enum<string>
required
Available options:
creating,
running,
stopped,
deleted,
error
size
enum<string>
required
Available options:
small,
medium,
large
mode
enum<string>
required
Available options:
paper,
live
runtime
enum<string>
required
Available options:
python,
node
markets
enum<string>[]
required
Available options:
perps,
outcomes,
spot
region
enum<string>
required
Available options:
tokyo
created_at
integer<int64>
required

Unix milliseconds

url
string<uri>
required

GET it for the box's state; DELETE it to delete the box.

dashboard
string<uri>
required
message
string
required

What the state means