Understand Your Data Access Rules
The GET /api/v1/account/my/data-access-rules endpoint helps professional and academic users audit their active subscriptions and constraints. It retrieves a comprehensive list of datasets currently associated with your account, along with specific access constraints such as permitted date ranges and ticker universes.
The GET /api/v1/account/my/data-access-rules endpoint helps professional and academic users audit their active subscriptions and constraints. It retrieves a comprehensive list of datasets currently associated with your account, along with specific access constraints such as permitted date ranges and ticker universes.
What are Access Rules?#
algoseek provides institutional-grade data often bundled into asset-class packages (Equities, Options, or Futures). This endpoint allows you to programmatically verify:
- Which specific datasets in your package are active.
- The historical depth you are permitted to access (e.g., starting from 2007 for Equities).
- Whether your access is restricted to a specific universe of tickers or is unrestricted.
Response Field Definitions#
The endpoint returns an array of MetaDatasetAccessRuleOut objects. The table below describes the fields included in each rule:
| Field | Type | Description |
|---|---|---|
dataset_text_id | String | A unique text identifier for the dataset, such as eq_taq. |
dataset_id | String | A short, unique internal dataset identifier (e.g., US1032). |
dataset_name | String | A human-readable display name, such as US Equities Trade and Quote. |
dataset_version | String | The version label of the dataset, typically latest. |
start_date | Date | The earliest date of the access period allowed for your account. |
end_date | Date | The final date of the access period; returns null if access is ongoing. |
universe_identifiers | Array | A list of permitted universe identifiers (e.g., ["AAPL", "MSFT"]). If the list is empty, there are no universe restrictions. |
Access Rule Examples#
Example 1: Full Package Access#
In this scenario, a user has a full Equities Package subscription with ongoing access to the complete historical archive and no ticker restrictions.
{
"dataset_text_id": "eq_taq",
"dataset_id": "US1032",
"dataset_name": "US Equities Trade and Quote",
"dataset_version": "latest",
"start_date": "2007-01-01",
"end_date": null,
"universe_identifiers": []
}
Example 2: Restricted Universe Access#
In this scenario, the account is restricted to a specific list of tickers, a common configuration for targeted research or testing phases.
{
"dataset_text_id": "opt_tanq",
"dataset_id": "US2050",
"dataset_name": "US Options Trade and NBBO Quote",
"dataset_version": "latest",
"start_date": "2024-01-01",
"end_date": "2024-12-31",
"universe_identifiers": ["AAPL", "MSFT", "IBM"]
}