Create an Ironbox
curl --request POST \
--url https://api.ironflow.sh/v1/ironbox \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "grid-bot",
"size": "small",
"mode": "paper",
"runtime": "python",
"markets": [
"perps",
"outcomes"
]
}
'import requests
url = "https://api.ironflow.sh/v1/ironbox"
payload = {
"name": "grid-bot",
"size": "small",
"mode": "paper",
"runtime": "python",
"markets": ["perps", "outcomes"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'grid-bot',
size: 'small',
mode: 'paper',
runtime: 'python',
markets: ['perps', 'outcomes']
})
};
fetch('https://api.ironflow.sh/v1/ironbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ironflow.sh/v1/ironbox",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'grid-bot',
'size' => 'small',
'mode' => 'paper',
'runtime' => 'python',
'markets' => [
'perps',
'outcomes'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ironflow.sh/v1/ironbox"
payload := strings.NewReader("{\n \"name\": \"grid-bot\",\n \"size\": \"small\",\n \"mode\": \"paper\",\n \"runtime\": \"python\",\n \"markets\": [\n \"perps\",\n \"outcomes\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ironflow.sh/v1/ironbox")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"grid-bot\",\n \"size\": \"small\",\n \"mode\": \"paper\",\n \"runtime\": \"python\",\n \"markets\": [\n \"perps\",\n \"outcomes\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ironflow.sh/v1/ironbox")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"grid-bot\",\n \"size\": \"small\",\n \"mode\": \"paper\",\n \"runtime\": \"python\",\n \"markets\": [\n \"perps\",\n \"outcomes\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "ibx_3f9a0c7e12d4",
"name": "grid-bot",
"state": "creating",
"size": "small",
"mode": "paper",
"runtime": "python",
"markets": [
"perps",
"outcomes"
],
"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."
}{
"error": {
"code": "INVALID_PARAMETER",
"message": "size must be one of small, medium, large (got \"xl\")"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "this request needs an API key. Free keys: https://ironflow.sh/key?utm_source=api, or POST https://api.ironflow.sh/v1/keys with {\"email\": \"[email protected]\"} (the key arrives by email)"
}
}{
"error": {
"code": "IRONBOX_LIMIT",
"message": "this key already has 3 Ironboxes, the most one key can have. Delete one first: DELETE https://api.ironflow.sh/v1/ironbox/{id} (GET https://api.ironflow.sh/v1/ironbox lists them)"
}
}Ironbox
Create an Ironbox
POST /v1/ironbox creates a secure, sandboxed environment in Tokyo, next to Hyperliquid, for your trading agent.
POST
/
v1
/
ironbox
Create an Ironbox
curl --request POST \
--url https://api.ironflow.sh/v1/ironbox \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "grid-bot",
"size": "small",
"mode": "paper",
"runtime": "python",
"markets": [
"perps",
"outcomes"
]
}
'import requests
url = "https://api.ironflow.sh/v1/ironbox"
payload = {
"name": "grid-bot",
"size": "small",
"mode": "paper",
"runtime": "python",
"markets": ["perps", "outcomes"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'grid-bot',
size: 'small',
mode: 'paper',
runtime: 'python',
markets: ['perps', 'outcomes']
})
};
fetch('https://api.ironflow.sh/v1/ironbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ironflow.sh/v1/ironbox",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'grid-bot',
'size' => 'small',
'mode' => 'paper',
'runtime' => 'python',
'markets' => [
'perps',
'outcomes'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ironflow.sh/v1/ironbox"
payload := strings.NewReader("{\n \"name\": \"grid-bot\",\n \"size\": \"small\",\n \"mode\": \"paper\",\n \"runtime\": \"python\",\n \"markets\": [\n \"perps\",\n \"outcomes\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ironflow.sh/v1/ironbox")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"grid-bot\",\n \"size\": \"small\",\n \"mode\": \"paper\",\n \"runtime\": \"python\",\n \"markets\": [\n \"perps\",\n \"outcomes\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ironflow.sh/v1/ironbox")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"grid-bot\",\n \"size\": \"small\",\n \"mode\": \"paper\",\n \"runtime\": \"python\",\n \"markets\": [\n \"perps\",\n \"outcomes\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "ibx_3f9a0c7e12d4",
"name": "grid-bot",
"state": "creating",
"size": "small",
"mode": "paper",
"runtime": "python",
"markets": [
"perps",
"outcomes"
],
"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."
}{
"error": {
"code": "INVALID_PARAMETER",
"message": "size must be one of small, medium, large (got \"xl\")"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "this request needs an API key. Free keys: https://ironflow.sh/key?utm_source=api, or POST https://api.ironflow.sh/v1/keys with {\"email\": \"[email protected]\"} (the key arrives by email)"
}
}{
"error": {
"code": "IRONBOX_LIMIT",
"message": "this key already has 3 Ironboxes, the most one key can have. Delete one first: DELETE https://api.ironflow.sh/v1/ironbox/{id} (GET https://api.ironflow.sh/v1/ironbox lists them)"
}
}See the Ironbox guide for the full flow in curl and Python.
Authorizations
Ironflow API key, format if_xxxx. Free keys at https://ironflow.sh/key. Optional on read endpoints.
Body
application/json
Your name for the box.
Maximum string length:
64Example:
"grid-bot"
Available options:
small, medium, large paper trades on paper, live on Hyperliquid.
Available options:
paper, live Available options:
python, node What the agent trades: perps (native and HIP-3), outcomes (HIP-4 prediction markets), spot.
Available options:
perps, outcomes, spot Anything we should know: strategy, markets, volume.
Maximum string length:
500Response
The Ironbox, in state creating.
Pattern:
^ibx_[0-9a-f]{12}$Example:
"ibx_3f9a0c7e12d4"
Empty when none was given.
Example:
"grid-bot"
Available options:
creating, running, stopped, deleted, error Available options:
small, medium, large Available options:
paper, live Available options:
python, node Available options:
perps, outcomes, spot Available options:
tokyo Unix milliseconds
GET it for the box's state; DELETE it to delete the box.
What the state means