Rotate a paper box URL

Get a new URL for a paper box

curl --request POST \
  --url https://api.ironflow.sh/v1/ironbox/{id}/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "unbind": false
}
'

import requests

url = "https://api.ironflow.sh/v1/ironbox/{id}/rotate"

payload = { "unbind": False }
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({unbind: false})
};

fetch('https://api.ironflow.sh/v1/ironbox/{id}/rotate', 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/{id}/rotate",
  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([
    'unbind' => false
  ]),
  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/{id}/rotate"

	payload := strings.NewReader("{\n  \"unbind\": false\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/{id}/rotate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"unbind\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ironflow.sh/v1/ironbox/{id}/rotate")

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  \"unbind\": false\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": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 60 seconds.",
    "upgrade": {
      "plan": "explorer",
      "price_usdc": 49,
      "days": 30,
      "unlocks": "<string>",
      "limit": "rate",
      "lifts": "60 requests a minute now, 100 on Explorer",
      "url": "<string>",
      "how": "<string>",
      "buy_url": "<string>",
      "pay_per_call": {},
      "offer": "<string>"
    },
    "get_key": {
      "method": "POST",
      "url": "https://api.ironflow.sh/v1/keys",
      "body": {
        "email": "[email protected]"
      },
      "page": "<string>"
    },
    "dataset": {
      "name": "Hyperliquid Liquidations",
      "url": "https://huggingface.co/datasets/ironflow/hyperliquid-liquidations?utm_source=api",
      "holds": "every liquidation",
      "from": "2025-05-25",
      "through": "2026-10-31"
    },
    "ironbox": {
      "why": "No rate limits inside an Ironbox: your agent runs next to Hyperliquid with the data on the box.",
      "create": "POST https://api.ironflow.sh/v1/ironbox",
      "url": "https://ironflow.sh/ironbox?utm_source=api"
    },
    "stream": "GET https://api.ironflow.sh/v1/liquidations/stream (no daily limit for keyless streams)",
    "allowed_from": 1794394800000,
    "did_you_mean": [
      "xyz:GOLD-PERP",
      "PAXG-PERP"
    ]
  }
}

{
  "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 is emailed to that address, never returned, so a person has to open the email)"
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 60 seconds.",
    "upgrade": {
      "plan": "explorer",
      "price_usdc": 49,
      "days": 30,
      "unlocks": "<string>",
      "limit": "rate",
      "lifts": "60 requests a minute now, 100 on Explorer",
      "url": "<string>",
      "how": "<string>",
      "buy_url": "<string>",
      "pay_per_call": {},
      "offer": "<string>"
    },
    "get_key": {
      "method": "POST",
      "url": "https://api.ironflow.sh/v1/keys",
      "body": {
        "email": "[email protected]"
      },
      "page": "<string>"
    },
    "dataset": {
      "name": "Hyperliquid Liquidations",
      "url": "https://huggingface.co/datasets/ironflow/hyperliquid-liquidations?utm_source=api",
      "holds": "every liquidation",
      "from": "2025-05-25",
      "through": "2026-10-31"
    },
    "ironbox": {
      "why": "No rate limits inside an Ironbox: your agent runs next to Hyperliquid with the data on the box.",
      "create": "POST https://api.ironflow.sh/v1/ironbox",
      "url": "https://ironflow.sh/ironbox?utm_source=api"
    },
    "stream": "GET https://api.ironflow.sh/v1/liquidations/stream (no daily limit for keyless streams)",
    "allowed_from": 1794394800000,
    "did_you_mean": [
      "xyz:GOLD-PERP",
      "PAXG-PERP"
    ]
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 60 seconds.",
    "upgrade": {
      "plan": "explorer",
      "price_usdc": 49,
      "days": 30,
      "unlocks": "<string>",
      "limit": "rate",
      "lifts": "60 requests a minute now, 100 on Explorer",
      "url": "<string>",
      "how": "<string>",
      "buy_url": "<string>",
      "pay_per_call": {},
      "offer": "<string>"
    },
    "get_key": {
      "method": "POST",
      "url": "https://api.ironflow.sh/v1/keys",
      "body": {
        "email": "[email protected]"
      },
      "page": "<string>"
    },
    "dataset": {
      "name": "Hyperliquid Liquidations",
      "url": "https://huggingface.co/datasets/ironflow/hyperliquid-liquidations?utm_source=api",
      "holds": "every liquidation",
      "from": "2025-05-25",
      "through": "2026-10-31"
    },
    "ironbox": {
      "why": "No rate limits inside an Ironbox: your agent runs next to Hyperliquid with the data on the box.",
      "create": "POST https://api.ironflow.sh/v1/ironbox",
      "url": "https://ironflow.sh/ironbox?utm_source=api"
    },
    "stream": "GET https://api.ironflow.sh/v1/liquidations/stream (no daily limit for keyless streams)",
    "allowed_from": 1794394800000,
    "did_you_mean": [
      "xyz:GOLD-PERP",
      "PAXG-PERP"
    ]
  }
}

POST

ironbox

{id}

rotate

Get a new URL for a paper box

curl --request POST \
  --url https://api.ironflow.sh/v1/ironbox/{id}/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "unbind": false
}
'

import requests

url = "https://api.ironflow.sh/v1/ironbox/{id}/rotate"

payload = { "unbind": False }
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({unbind: false})
};

fetch('https://api.ironflow.sh/v1/ironbox/{id}/rotate', 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/{id}/rotate",
  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([
    'unbind' => false
  ]),
  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/{id}/rotate"

	payload := strings.NewReader("{\n  \"unbind\": false\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/{id}/rotate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"unbind\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ironflow.sh/v1/ironbox/{id}/rotate")

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  \"unbind\": false\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": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 60 seconds.",
    "upgrade": {
      "plan": "explorer",
      "price_usdc": 49,
      "days": 30,
      "unlocks": "<string>",
      "limit": "rate",
      "lifts": "60 requests a minute now, 100 on Explorer",
      "url": "<string>",
      "how": "<string>",
      "buy_url": "<string>",
      "pay_per_call": {},
      "offer": "<string>"
    },
    "get_key": {
      "method": "POST",
      "url": "https://api.ironflow.sh/v1/keys",
      "body": {
        "email": "[email protected]"
      },
      "page": "<string>"
    },
    "dataset": {
      "name": "Hyperliquid Liquidations",
      "url": "https://huggingface.co/datasets/ironflow/hyperliquid-liquidations?utm_source=api",
      "holds": "every liquidation",
      "from": "2025-05-25",
      "through": "2026-10-31"
    },
    "ironbox": {
      "why": "No rate limits inside an Ironbox: your agent runs next to Hyperliquid with the data on the box.",
      "create": "POST https://api.ironflow.sh/v1/ironbox",
      "url": "https://ironflow.sh/ironbox?utm_source=api"
    },
    "stream": "GET https://api.ironflow.sh/v1/liquidations/stream (no daily limit for keyless streams)",
    "allowed_from": 1794394800000,
    "did_you_mean": [
      "xyz:GOLD-PERP",
      "PAXG-PERP"
    ]
  }
}

{
  "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 is emailed to that address, never returned, so a person has to open the email)"
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 60 seconds.",
    "upgrade": {
      "plan": "explorer",
      "price_usdc": 49,
      "days": 30,
      "unlocks": "<string>",
      "limit": "rate",
      "lifts": "60 requests a minute now, 100 on Explorer",
      "url": "<string>",
      "how": "<string>",
      "buy_url": "<string>",
      "pay_per_call": {},
      "offer": "<string>"
    },
    "get_key": {
      "method": "POST",
      "url": "https://api.ironflow.sh/v1/keys",
      "body": {
        "email": "[email protected]"
      },
      "page": "<string>"
    },
    "dataset": {
      "name": "Hyperliquid Liquidations",
      "url": "https://huggingface.co/datasets/ironflow/hyperliquid-liquidations?utm_source=api",
      "holds": "every liquidation",
      "from": "2025-05-25",
      "through": "2026-10-31"
    },
    "ironbox": {
      "why": "No rate limits inside an Ironbox: your agent runs next to Hyperliquid with the data on the box.",
      "create": "POST https://api.ironflow.sh/v1/ironbox",
      "url": "https://ironflow.sh/ironbox?utm_source=api"
    },
    "stream": "GET https://api.ironflow.sh/v1/liquidations/stream (no daily limit for keyless streams)",
    "allowed_from": 1794394800000,
    "did_you_mean": [
      "xyz:GOLD-PERP",
      "PAXG-PERP"
    ]
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 60 seconds.",
    "upgrade": {
      "plan": "explorer",
      "price_usdc": 49,
      "days": 30,
      "unlocks": "<string>",
      "limit": "rate",
      "lifts": "60 requests a minute now, 100 on Explorer",
      "url": "<string>",
      "how": "<string>",
      "buy_url": "<string>",
      "pay_per_call": {},
      "offer": "<string>"
    },
    "get_key": {
      "method": "POST",
      "url": "https://api.ironflow.sh/v1/keys",
      "body": {
        "email": "[email protected]"
      },
      "page": "<string>"
    },
    "dataset": {
      "name": "Hyperliquid Liquidations",
      "url": "https://huggingface.co/datasets/ironflow/hyperliquid-liquidations?utm_source=api",
      "holds": "every liquidation",
      "from": "2025-05-25",
      "through": "2026-10-31"
    },
    "ironbox": {
      "why": "No rate limits inside an Ironbox: your agent runs next to Hyperliquid with the data on the box.",
      "create": "POST https://api.ironflow.sh/v1/ironbox",
      "url": "https://ironflow.sh/ironbox?utm_source=api"
    },
    "stream": "GET https://api.ironflow.sh/v1/liquidations/stream (no daily limit for keyless streams)",
    "allowed_from": 1794394800000,
    "did_you_mean": [
      "xyz:GOLD-PERP",
      "PAXG-PERP"
    ]
  }
}

See the Ironbox guide for the full flow.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Pattern: ^ibx_[0-9a-f]{12}$

Body

application/json

unbind

boolean

default:false

Clear the wallet binding too.

Response

The box with its new base_url.

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

Ironbox is paper only.

Available options:

paper

runtime

enum<string>

required

Available options:

python,

node

markets

enum<string>[]

required

Available options:

perps,

outcomes,

spot

region

enum<string>

required

Available options:

tokyo,

paper

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

paper

boolean

True for a paper box: your own simulated Hyperliquid account.

trial

boolean

True on the answer that creates a keyless trial box.

expires_at

integer<int64>

When a trial box ends at the latest, Unix milliseconds. It ends sooner after 2 hours with no requests and no strategy running. Only on a keyless trial box.

strategies_url

string<uri>

Where to start strategies on this box. Shown only with base_url.

activity_url

string<uri>

Where to watch this box. Shown only with base_url.

base_url

string<uri>

Set base_url in the official Hyperliquid SDK to this. Shown only when the box is created or rotated. Treat it as a low-value secret.

Example:

"https://api.ironflow.sh/box/ibxs_1f2e3d4c5b6a7890123456789abcdef0123456789abcdef0123456789abcdef0"

snippet

string

A first Python program for this box. Shown only when the box is created or rotated.

starting_balance_usd

number

Starting balance of a new paper box.

stats

object

A paper box's account, on GET. as_of is live or, if the engine cannot be reached, snapshot.

Show child attributes