odf-query

Execute a batch query

Functions exactly like the POST version of the endpoint with all parameters passed in the query string instead of the body.

get/query

Query parameters

querystring required

Query to execute (e.g. SQL)

queryDialectstring

Dialect of the query

skipinteger

Number of leading records to skip when returning result (used for pagination)

limitinteger

Maximum number of records to return (used for pagination)

dataFormat'JsonAoS' | 'JsonSoA' | 'JsonAoA'

How the output data should be encoded

schemaFormat'ArrowJson' | 'OdfJson' | 'OdfYaml' | 'Parquet' | 'ParquetJson' required

How to encode the schema of the result

includestring

What information to include in the response

Response

Example response

{
  "commitment": {
    "inputHash": "f162070983d692f648185febe6d6fa607630ae68649f7e6fc45b94680096c06e4fadb",
    "outputHash": "f162070983d692f648185febe6d6fa607630ae68649f7e6fc45b94680096c06e4fadb",
    "subQueriesHash": "f162070983d692f648185febe6d6fa607630ae68649f7e6fc45b94680096c06e4fadb"
  },
  "input": {
    "datasets": [
      {
        "alias": "kamu/eth-to-usd",
        "blockHash": "f162070983d692f648185febe6d6fa607630ae68649f7e6fc45b94680096c06e4fadb",
        "id": "did:odf:fed01969b7413a41f25ba969b7413a41f25ba4016461736574607650ec170632ade10"
      }
    ],
    "query": "select event_time, from, to, close from \"kamu/eth-to-usd\""
  },
  "proof": {
    "proofValue": "uAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "verificationMethod": "did:key:z6MkmgVreHBu2ABaD59Jq1J2JneXwzpsUWwEWXS4kLhjb4V4"
  },
  "subQueries": []
}

Changes

Changed in 3 of the 53 revisions of this API.2810

Jun 4, 2026af210e5a088a2See the full diff
- ●
  added the new EcdsaSecp256k1Signature2019 enum value to the proof/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new EcdsaSecp256k1Signature2019 enum value to the subQueries/items/proof/type response property for the response status 200
  response-property-enum-value-added
Aug 3, 2025411fe35264fd62See the full diff
- ●
  added the new OdfJson enum value to the input/schemaFormat response property for the response status 200
  response-property-enum-value-added
- ●
  added the new OdfJson enum value to the output/schemaFormat response property for the response status 200
  response-property-enum-value-added
- ●
  added the new OdfJson enum value to the subQueries/items/input/schemaFormat response property for the response status 200
  response-property-enum-value-added
- ●
  added the new OdfYaml enum value to the input/schemaFormat response property for the response status 200
  response-property-enum-value-added
- ●
  added the new OdfYaml enum value to the output/schemaFormat response property for the response status 200
  response-property-enum-value-added
- ●
  added the new OdfYaml enum value to the subQueries/items/input/schemaFormat response property for the response status 200
  response-property-enum-value-added
- ○
  added the new enum value OdfJson to the query request parameter schemaFormat
  request-parameter-enum-value-added
- ○
  added the new enum value OdfYaml to the query request parameter schemaFormat
  request-parameter-enum-value-added
Jul 29, 20259aea0047e18e28See the full diff
- ▲
  removed the enum value OdfJson from the query request parameter schemaFormat
  request-parameter-enum-value-removed
- ▲
  removed the enum value OdfYaml from the query request parameter schemaFormat
  request-parameter-enum-value-removed
- ○
  removed the EcdsaSecp256k1Signature2019 enum value from the proof/type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the EcdsaSecp256k1Signature2019 enum value from the subQueries/items/proof/type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the OdfJson enum value from the input/schemaFormat response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the OdfJson enum value from the output/schemaFormat response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the OdfJson enum value from the subQueries/items/input/schemaFormat response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the OdfYaml enum value from the input/schemaFormat response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the OdfYaml enum value from the output/schemaFormat response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the OdfYaml enum value from the subQueries/items/input/schemaFormat response property for the response status 200
  response-property-enum-value-removed
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history