Skip to main content
POST
crypto.onchain.sql-estimate

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
sql
string
required

Read-only ClickHouse SELECT/WITH query to validate and estimate WITHOUT executing. Same shape and rules as /onchain/sql. Rules (server-enforced or query-killing): SELECT/WITH only (read-only); table r.

Required string length: 1 - 20000
maxRows
integer

Maximum rows to return. Example: 100. Defaults to 1000 (server-side), capped at 10000.

Required range: 0 <= x <= 1000000

Response

The result

budgetMaxBytesToRead
number
required

Budget max bytes to read: how many.

estimateByTable
object[]

Estimate by table.

tables
object[]

Tables.

warnings
object[]

Warnings.

budgetMaxExecutionTimeSeconds
number

Budget max execution time seconds.

budgetMaxRowsToRead
number

Budget max rows to read.

estimateBytes
number

Estimate bytes: how many.

estimateMarks
number

Estimate marks.

estimateParts
number

Estimate parts.

estimateRows
number

Estimate rows.

accepted
boolean

True when accepted.

executedSql
string

Executed sql.

queryId
string

Query id.

sql
string

Sql.