Skip to content
OnchainQueries

OQ — A00 · APIs & CLI

There is no privileged internal path. The CLI submits SQL, polls status, attaches to running queries and cancels them over the public control API — so anything the CLI can do, your code can do.

Commands
5
Parameter types
13
Transports
2
Request limit
2 MiB
OQ — A01Lifecycle

OnchainQueries assigns every query an ID. Keep it and you can walk away — the server-side query keeps running whether or not your shell does.

a full session
query login query sql \  --file trades.sql \  --param 'start_time:timestamp=2026-08-01 00:00:00' \  --engine auto \  --transport parquet \  --output ./results query status 8f31c2query attach 8f31c2 --output ./resultsquery cancel 8f31c2
queued
Accepted and waiting to run
running
Executing
complete
Results are ready
failed
Execution ended with an error
cancelling
Cancellation was requested
cancelled
Execution was cancelled
expired
Query or result no longer available
OQ — A02Interfaces

query sql

--file, --param, --transport

Submit a statement, wait for a terminal state, and download verified results in one command.

query status

status · attach · cancel

Inspect a query as JSON, resume an interrupted download, or release its capacity early.

query shell

interactive

Statement-at-a-time exploration. Always auto engine and parquet transport; no typed parameters.

Control API

protobuf, port 8081

The transport underneath all of the above. The control API carries metadata only — result data never passes through it.

Typed parameters, checksum-verified parts, and a manifest you can assert on in CI.

Read the CLI docsData exports