Skip to main content
Allium Beam lets you create custom-filtered, real-time blockchain data pipelines. Pick a chain and entity from Allium’s Datastreams, apply filters and JavaScript transforms, and deliver the processed data to Kafka, SNS, your own Kafka cluster, or a webhook — all without building infrastructure.

​
Authentication

Base URL: https://api.allium.so/api/v1/beam All endpoints require an API key passed via the X-API-Key header:
Get your API key from app.allium.so/settings/api-keys.

​
Getting a pipeline running

1

Create a pipeline config

Use Create pipeline to define your source (chain + entity), transforms (set filter and/or JavaScript), and sinks (where data is delivered). The response includes the generated pipeline id and transform uids you’ll need for the next steps.
2

Deploy

Call Deploy to spin up workers, create topics, and start streaming data. Deployment takes a few seconds.
3

Monitor

Check Deployment stats for worker health and Deployment metrics for throughput, latency, and error rates.
4

Iterate

Update your config or transforms at any time, then redeploy — it’s idempotent with zero downtime. Filter value changes take effect immediately without a redeploy.

​
Endpoint groups

Configs

Create, read, update, and delete pipeline configurations.

Deployment

Deploy, teardown, and monitor running pipelines.

Transforms

Update transforms on a deployed pipeline.

Filter Values

Manage values in set filter transforms (supports 10M+ values).
See the Configuration reference for full details on the BeamConfig schema (sources, transforms, sinks, and field types).