Skip to main content
GET
/
api
/
v1
/
beam
/
datasets
/
{dataset_id}
/
entries
List Entries Handler
curl --request GET \
  --url https://api.allium.so/api/v1/beam/datasets/{dataset_id}/entries \
  --header 'X-API-KEY: <api-key>'
{
  "values": [
    "<string>"
  ],
  "cursor": "<string>",
  "total_count": 123
}
Returns a paginated list of values in the dataset, sorted alphabetically. Path parameters:
ParameterDescription
dataset_idDataset ID
Query parameters:
ParameterDefaultDescription
cursornullPagination cursor from a previous response
limit10000Number of values per page (1-500,000)
curl -X GET "https://api.allium.so/api/v1/beam/datasets/${DATASET_ID}/entries?limit=10000" \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
Response: 
{
  "values": ["0x3c499c542cef5e3811e1192ce70d8cc03d5c3359", "0xc2132d05d31c914a87c6611c10748aeb04b58e8f"],
  "cursor": "0xc2132d05d31c914a87c6611c10748aeb04b58e8f",
  "total_count": 1500
}
FieldDescription
valuesArray of values in the current page
cursorCursor for the next page, null if no more pages
total_countTotal number of values in the dataset

​
Retrieving all entries

Use the cursor field to paginate through the full dataset: 
import httpx

PAGE_SIZE = 500_000

def list_all_entries(dataset_id: str, api_key: str) -> list[str]:
    all_values = []
    cursor = None

    with httpx.Client(headers={"X-API-Key": api_key}) as client:
        while True:
            params = {"limit": PAGE_SIZE}
            if cursor:
                params["cursor"] = cursor

            resp = client.get(
                f"https://api.allium.so/api/v1/beam/datasets/{dataset_id}/entries",
                params=params,
            )
            resp.raise_for_status()
            data = resp.json()

            all_values.extend(data["values"])
            cursor = data.get("cursor")

            if not cursor:
                break

    return all_values

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
dataset_id
string
required

Query Parameters

​
cursor
string
​
limit
integer
default:10000
Required range: 1 <= x <= 500000

Response

Successful Response

​
values
string[]
required
​
cursor
string | null
required
​
total_count
integer
required