Overview
Each stream payload contains two top-level fields:
metadata— an object containing metadata about the stream and batch.data— the dataset itself. The shape ofdatadepends on the selected dataset type and chain client's structure for the given data. We do not modify the structure of the underlying data.
Metadata Configuration Options
You can control how metadata is delivered in your stream:
- Header delivery: Metadata included in HTTP response headers
- Body delivery: Metadata included in the response payload (shown above)
- None: Metadata delivery disabled entirely
Note: Metadata is sent once per batch, not per individual data record.
Stream Metadata Properties (once per batch)
| Property | Type | Description | Example |
|---|---|---|---|
| batch_end_range | integer | Ending range of batches in a dataset | 19271294 |
| batch_start_range | integer | Starting range of batches in a dataset | 19271294 |
| blocks_reorged | null or array | blocks in the batch which are sent as a result of a reorg | null or [ 19271294 ] |
| dataset | string | Type of dataset | "block" |
| end_range | integer | Ending range of data capture | 200 |
| keep_distance_from_tip | integer | Distance from the tip | 0 |
| network | string | Relevant blockchain network | "ethereum-mainnet" |
| start_range | integer | Starting range of data capture | 100 |
| stream_id | string | ID of the stream | "f6ad6459-b5ad-4183-b370-1c1388e47e83" |
| stream_name | string | Name associated with the metadata | "stream test1" |
| stream_region | string | Region of the stream | "usa_east" |