Skip to main content
The list endpoint returns every dataset your account can access, spanning all repositories you own or have been granted permission to view. Use this endpoint to discover available datasets, check their names and IDs, and determine which repository each dataset belongs to before fetching its data.

Authentication

Authenticate using HTTP Basic Auth. Pass your API key as the username and leave the password empty.
curl -u YOUR_API_KEY: https://api.alphacast.io/datasets

Request

Method: GET
URL: https://api.alphacast.io/datasets
No query parameters or request body are required.

Response

Returns a JSON array of dataset objects. Each object represents one dataset accessible to your account.
id
integer
Unique numeric identifier for the dataset.
name
string
Display name of the dataset.
repositoryId
integer
ID of the repository this dataset belongs to.
description
string
Optional human-readable description of the dataset’s contents.
sourceName
string
Name of the original data source, if provided at creation time.
sourceUrl
string
URL linking to the original data source, if provided at creation time.
permission
string
Your permission level on this dataset. One of Read, Write, or Admin.
frequency
string
Inferred data frequency of the dataset (e.g., monthly, daily). May be null if not yet determined.
minDate
string
Earliest date present in the dataset, in YYYY-MM-DD format. May be null if the dataset is empty.
maxDate
string
Latest date present in the dataset, in YYYY-MM-DD format. May be null if the dataset is empty.

Example

curl -u YOUR_API_KEY: https://api.alphacast.io/datasets
[
  {
    "id": 123,
    "name": "US GDP Quarterly",
    "repositoryId": 45,
    "description": "Quarterly US GDP figures from BEA",
    "sourceName": "Bureau of Economic Analysis",
    "sourceUrl": "https://www.bea.gov/data/gdp",
    "permission": "Admin",
    "frequency": "quarterly",
    "minDate": "1947-01-01",
    "maxDate": "2024-10-01"
  },
  {
    "id": 124,
    "name": "CPI Monthly",
    "repositoryId": 45,
    "description": null,
    "sourceName": null,
    "sourceUrl": null,
    "permission": "Read",
    "frequency": "monthly",
    "minDate": "2000-01-01",
    "maxDate": "2024-11-01"
  }
]
This endpoint returns only datasets your account has at least Read permission on. Datasets in repositories you cannot access are not included in the response.