Prerequisites: You need an Allium API key. Get one from app.allium.so/settings/api-keys.
Setup
X-API-Key header. The base URL is https://api.allium.so/api/v1/beam.
Filter USDC transfers on Base
1
Create the pipeline config
Create a pipeline that streams ERC-20 transfers on Base, filters them by token address, and delivers them to an Allium-managed Kafka topic.The transform keeps only transfers of the USDC contract on Base and drops the rest by returning
null. Use lowercase addresses: Allium data stores addresses in lowercase, and matching is exact.The response contains the full BeamConfig, including its generated id.2
Deploy
{"message": "Pipeline <CONFIG_ID> successfully deployed"}3
Check deployment health
healthy_workers should equal total_workers. If workers are still starting, wait a few seconds and retry. Data now streams to the beam.${CONFIG_ID}.usdc-transfers topic.What’s next
- Update the pipeline: send the new config to
PUT /api/v1/beam/{config_id}, then redeploy. You don’t need to tear down first. - Monitor throughput: call
GET /api/v1/beam/{config_id}/deploy/metrics?time_range=1h&aggregated=truefor a summary. - Filter on a list: put addresses in a dataset and check them with
beam.contains(). Dataset changes apply with no redeploy.
API reference
Full endpoint reference
Configuration reference
Source, transform, and sink schemas