List Streams

GET

Returns the available Stream types, their structures, and CEL schema list for Flexible Webhook subscriptions. Use the streamId to create a Flexible Webhook subscription and receive data matching the stream's schema at the destination endpoint you specify.

Path Parameters

chainstringrequired

Parameter specifying the target chain to query.

networkstringrequired

Parameter specifying the network of the target chain.

Query Parameters

pageinteger

Page number to retrieve. Starts from 1.

rppinteger

Number of results per page. Minimum 1, maximum 100. Defaults to 10.

Responses

totalinteger

Total number of Streams matching the query conditions.

pageinteger

Current page number.

rppinteger

Number of results per page.

List of Streams on the current page.

streamIdstring

The unique ID of the on-chain data trackable via Flexible Webhook. You can look this up using the List Flexible Streams API.

slugstring

A human-readable identifier for the stream.

chainstring

The name of the blockchain from which data is retrieved.

networkstring

The network of the blockchain from which data is retrieved (e.g., "mainnet", "testnet").

descriptionstring

A description of the stream. Returns null if not provided.

schemaobject

The JSON Schema for the Stream event payload.

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' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo'