Start the 7-day Explorer trial
curl --request POST \
--url https://api.ironflow.sh/v1/billing/trial \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ironflow.sh/v1/billing/trial"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ironflow.sh/v1/billing/trial', 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/billing/trial",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ironflow.sh/v1/billing/trial"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/billing/trial")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ironflow.sh/v1/billing/trial")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"eligible": false,
"plan": "explorer",
"days": 7,
"credits_per_day": 25000,
"price_usdc": 49,
"pay_url": "https://ironflow.sh/upgrade?plan=explorer&utm_source=api&utm_medium=trial",
"trial": {
"status": "running",
"started_at": "2026-11-15T14:21:00Z",
"ends_at": "2026-11-22T14:21:00Z"
},
"message": "Your key has Explorer limits until 22 November 2026 14:21 UTC: 25,000 credits a day and no monthly cap. After that it goes back to the free limits, unless you pay: Explorer is 49 USDC for 30 days at https://ironflow.sh/upgrade?plan=explorer&utm_source=api&utm_medium=trial. We email you 2 days before the end."
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"error": {
"code": "TRIAL_NO_CAP",
"message": "the trial is for free accounts that used up their credits: this account has not hit its daily (1,000) or monthly (3,000) credits in the last 30 days"
}
}{
"error": {
"code": "TRIAL_USED",
"message": "there is one trial per person, and this account (or its email) had it; Explorer is 49 USDC for 30 days at https://ironflow.sh/upgrade?plan=explorer&utm_source=api&utm_medium=trial"
}
}{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Retry after 60 seconds.",
"upgrade": {
"trial": {
"plan": "explorer",
"days": 7,
"credits_per_day": 25000,
"start": "POST https://api.ironflow.sh/v1/billing/trial",
"message": "<string>"
},
"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": {},
"resets_at": "2026-12-01T00:00:00Z",
"early_offer": {
"plan": "builder-early",
"price_usdc": 49,
"days": 30,
"payments": 3,
"then_price_usdc": 149,
"unlocks": "<string>",
"url": "https://ironflow.sh/upgrade?utm_source=api&plan=builder-early&limit=monthly_quota",
"how": "<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 (1 credit a minute)",
"allowed_from": 1794394800000,
"did_you_mean": [
"xyz:GOLD-PERP",
"PAXG-PERP"
],
"detail": "<string>",
"nearest_routes": [
"/v1/liquidations",
"/v1/liquidations/summary"
]
}
}Keys and billing
Start a 7-day Explorer trial
POST /v1/billing/trial gives a free account that used up its credits Explorer’s limits for 7 days, once per person, with the same key and no payment details.
POST
/
v1
/
billing
/
trial
Start the 7-day Explorer trial
curl --request POST \
--url https://api.ironflow.sh/v1/billing/trial \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ironflow.sh/v1/billing/trial"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ironflow.sh/v1/billing/trial', 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/billing/trial",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ironflow.sh/v1/billing/trial"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/billing/trial")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ironflow.sh/v1/billing/trial")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"eligible": false,
"plan": "explorer",
"days": 7,
"credits_per_day": 25000,
"price_usdc": 49,
"pay_url": "https://ironflow.sh/upgrade?plan=explorer&utm_source=api&utm_medium=trial",
"trial": {
"status": "running",
"started_at": "2026-11-15T14:21:00Z",
"ends_at": "2026-11-22T14:21:00Z"
},
"message": "Your key has Explorer limits until 22 November 2026 14:21 UTC: 25,000 credits a day and no monthly cap. After that it goes back to the free limits, unless you pay: Explorer is 49 USDC for 30 days at https://ironflow.sh/upgrade?plan=explorer&utm_source=api&utm_medium=trial. We email you 2 days before the end."
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"error": {
"code": "TRIAL_NO_CAP",
"message": "the trial is for free accounts that used up their credits: this account has not hit its daily (1,000) or monthly (3,000) credits in the last 30 days"
}
}{
"error": {
"code": "TRIAL_USED",
"message": "there is one trial per person, and this account (or its email) had it; Explorer is 49 USDC for 30 days at https://ironflow.sh/upgrade?plan=explorer&utm_source=api&utm_medium=trial"
}
}{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Retry after 60 seconds.",
"upgrade": {
"trial": {
"plan": "explorer",
"days": 7,
"credits_per_day": 25000,
"start": "POST https://api.ironflow.sh/v1/billing/trial",
"message": "<string>"
},
"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": {},
"resets_at": "2026-12-01T00:00:00Z",
"early_offer": {
"plan": "builder-early",
"price_usdc": 49,
"days": 30,
"payments": 3,
"then_price_usdc": 149,
"unlocks": "<string>",
"url": "https://ironflow.sh/upgrade?utm_source=api&plan=builder-early&limit=monthly_quota",
"how": "<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 (1 credit a minute)",
"allowed_from": 1794394800000,
"did_you_mean": [
"xyz:GOLD-PERP",
"PAXG-PERP"
],
"detail": "<string>",
"nearest_routes": [
"/v1/liquidations",
"/v1/liquidations/summary"
]
}
}Authorizations
Ironflow API key, format if_xxxx. Free keys at https://ironflow.sh/key. Optional on read endpoints.
Response
The trial started.