Get list of events in stream

GET /v4/stream/{stream}

List events in a stream. The path parameter stream specifies which stream to list events from.

Query parameters

Parameter	Type	Description
start_tx	integer<int64>	Optional. Starting event ID to list from (inclusive).
end_tx	integer<int64>	Optional. Ending event ID to list to (inclusive).
limit	integer<int64>	Optional. Maximum number of events to return.

Response schema

Array of Event objects, where each Event contains:

Field	Type	Description
tx	integer<int64>	Event ID.
data	any	The event data.
binary	boolean	Whether the event data is in binary format. The event data is base64 encoded in the response for binary data, or JSON object for non-binary.

Examples

List recent events

curl --location 'https://api.litebase.io/v4/stream/sample' \
--header "Authorization: Bearer $LITEBASE_API_KEY"

Response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "tx": 2,
        "binary": false,
        "data": "base64EncodedData1"
    },
    {
        "tx": 1,
        "binary": false,
        "data": "base64EncodedData2"
    }
]

List with specific event range

curl --location 'https://api.litebase.io/v4/stream/sample?start_tx=1&end_tx=2&limit=1' \
--header "Authorization: Bearer $LITEBASE_API_KEY"

Response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "tx": 1,
        "data": "hello world"
    },
    {
        "tx": 2,
        "data": {
            "name": "Braavos",
            "type": "city_created"
        }
    },
    {
        "tx": 3,
        "binary": true,
        "data": "base64EncodedData"
    }
]

Note: The event data is base64 encoded in the response for binary data, or JSON object for non-binary.