Skip to main content
Use the Allium Beam API to create and operate filtered, realtime blockchain data pipelines. Choose a chain and entity from Allium Datastreams, apply filters and JavaScript transforms, and deliver the results to Kafka, SNS, NATS JetStream, a webhook, or your own Kafka cluster.

​
Authentication

Base URL: https://api.allium.so/api/v1/beam Authenticate every request with your API key in the X-API-Key header:
Create an API key at app.allium.so/settings/api-keys.

​
Run a pipeline

1

Create a pipeline config

Call Create pipeline with a source (chain and entity), transforms (set filter, JavaScript, or both), and sinks (delivery destinations). The response includes the pipeline id and each transform’s uid.
2

Deploy

Call Deploy to start the pipeline. Deployment takes a few seconds.
3

Monitor

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

Iterate

Update the config or transforms at any time and redeploy. Deploys are idempotent and zero-downtime. Filter value changes take effect immediately, with no redeploy.

​
Pausing and data retention

Pause stops processing but keeps the deployment in place. Call Deploy to resume. While paused, Beam retains incoming data for up to 2 days. Older data is dropped and not delivered on resume, so resume within 2 days to avoid data loss. Teardown removes the deployment. Data that arrives between teardown and the next deploy is not delivered.

​
Endpoint groups

Configs

Create, read, update, and delete pipeline configurations.

Deployment

Deploy, pause, tear down, and monitor pipelines.

Filter values

Manage the values in set filters (deprecated; use datasets instead).

Datasets

Manage named value sets your JavaScript transforms query with beam.contains().

Backfills

Deliver historical data to a destination for a past time window.
See the configuration reference for the full BeamConfig schema.