Skip to main content
GET
Run a read-only SQL query from a URL

Authorizations

Authorization
string
header
required

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

Query Parameters

sql
string
required

One read-only ClickHouse statement, URL-encoded.

Maximum string length: 20000
max_rows
integer

Most rows to return. Defaults to, and is capped at, the tier limit.

Required range: x >= 1

Response

200 - application/json

Query result.

columns
object[]
required
rows
any[][]
required

Positional rows in columns order. Numbers stay JSON numbers; times are UTC strings.

row_count
integer
required
truncated
boolean
required

More rows existed than max_rows.

stats
object
required
limits
object
required
budget_remaining_seconds
number
required