Structured Query

POST /gateway/v1/onchain/query

Blockchain Structured Query

cURL

curl --request POST \
  --url https://api.asksurf.ai/gateway/v1/onchain/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "agent.my_table",
  "fields": [
    "transaction_hash",
    "from_address",
    "value"
  ],
  "filters": [
    {
      "field": "block_number",
      "op": "eq",
      "value": "<unknown>"
    }
  ],
  "limit": 20,
  "offset": 0,
  "sort": [
    {
      "field": "gas",
      "order": "desc"
    }
  ]
}
'

200

{
  "data": [
    {}
  ],
  "meta": {
    "cached": true,
    "credits_used": 123,
    "limit": 123,
    "offset": 123,
    "total": 123
  },
  "$schema": "https://example.com/schemas/DataResponseOnchainRow.json"
}

Body

application/json

source · string · required

Fully-qualified table name like agent.my_table

Example:

"agent.my_table"

fields · string[] | null

Columns to return. Omit to return all columns. Example for agent.ethereum_transactions: [transaction_hash, from_address, value]

Example:

["transaction_hash", "from_address", "value"]

filters · object[] | null

WHERE conditions (ANDed together)

Show child attributes

limit · integer<int64>

Max rows to return. Default 20, max 10000

Example:

20

offset · integer<int64>

Rows to skip for pagination. Default 0

Example:

0

sort · object[] | null

ORDER BY clauses

Show child attributes

Response

200

application/json

OK

data · object[] | null · required

Show child attributes

meta · object · required

Show child attributes

$schema · string<uri> · read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/DataResponseOnchainRow.json"