Skip to main content
GET
/
api
/
v1
/
beam
/
sources
List available sources
curl --request GET \
  --url https://api.example.com/api/v1/beam/sources
GET /api/v1/beam/sources
Returns the catalog of chains/entities currently available to use as a Beam pipeline source, along with whether each one is served via Kafka or PubSub. Requires a Beam-enabled organization and an API key with the custom_transforms feature. 
curl -X GET https://api.allium.so/api/v1/beam/sources \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
Response: 
{
  "sources": [
    {
      "chain": "ethereum",
      "entity": "log",
      "zerolag": false,
      "consolidated": true,
      "default_size": "S",
      "source_type": "pubsub"
    },
    {
      "chain": "hyperliquid",
      "entity": "order",
      "zerolag": false,
      "consolidated": false,
      "default_size": "M",
      "source_type": "kafka"
    }
  ]
}
FieldDescription
chainBlockchain identifier (use as chain in a pipeline source config)
entityEntity type (use as entity in a pipeline source config)
zerolagWhether this source emits pre-finality data
consolidatedInternal indicator of the source’s PubSub topic layout
default_sizeSuggested pod size for a pipeline using this source
source_type"kafka" or "pubsub" — the transport this source is served over