Get Stream Schema

GET

Retrieves the JSON Schema and filterable CEL field list for a specific stream. Use filterFields, bigintFields, and addressFields as a reference when writing CEL filter expressions.

Path Parameters

chainstringrequired

Parameter specifying the target chain to query.

networkstringrequired

Parameter specifying the network of the target chain.

streamIdstringrequired

The unique ID that identifies a Stream.

Responses

streamIdstring

The unique ID that identifies a Stream.

schemaobject

The full JSON Schema of the Stream payload. Use this to inspect the type and structure of each field.

filterFieldsarray

List of fields that can be used as filter conditions in a CEL expression.

bigintFieldsarray

List of fields with bigint values. Take care with numeric comparisons when writing CEL expressions.

addressFieldsarray

List of fields containing blockchain address values. Use the address_eq() function in CEL expressions for these fields.

codestringrequired

Code identifying the cause of the failed request.

messagestringrequired

Detailed message including the name and value of the invalid parameter.

{
  "code": "MISSING_REQUIRED_PARAMETER",
  "message": "Missing required parameter: { PARAMETER_NAME }"
}

X-API-KEY

cURL

curl -X GET 'https://web3.nodit.io/v1/avalanche/mainnet/flexible-webhooks/streams/77/schema' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo'