List datasets

Returns all datasets owned by the authenticated user.

GET /api/v1/beam/datasets

List datasets

cURL

curl --request GET \
  --url https://api.example.com/api/v1/beam/datasets

Returns all datasets belonging to the authenticated user.

Query Parameters

Parameter	Type	Required	Description
names	list of strings	No	Filter results to only datasets with these names. Repeat for multiple values.

Examples

List all datasets:

curl -X GET https://api.allium.so/api/v1/beam/datasets \
  -H "X-API-Key: ${ALLIUM_API_KEY}"

Filter by name:

curl -X GET "https://api.allium.so/api/v1/beam/datasets?names=my-contracts&names=my-wallets" \
  -H "X-API-Key: ${ALLIUM_API_KEY}"

Response:

[
  {
    "id": "a1b2c3d4",
    "name": "my-contracts",
    "type": "postgres",
    "created_at": "2024-01-15T10:00:00Z",
    "updated_at": "2024-01-15T10:00:00Z"
  }
]

Field	Description
id	Unique dataset ID
name	Dataset name
type	Storage type (always postgres)
created_at	ISO 8601 creation timestamp
updated_at	ISO 8601 last-updated timestamp