Skip to main content

Understand Your Data Access Rules

The GET /v1/account/my/data-access-rules endpoint helps API 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:

FieldTypeDescription
dataset_idStringA short, unique internal dataset identifier (e.g., US1032).
dataset_nameStringA human-readable display name, such as US Equities Trade and Quote.
dataset_versionStringThe version label of the dataset, typically latest.
start_dateDateThe earliest date of the access period allowed for your account.
end_dateDateThe final date of the access period; returns null if access is ongoing.
universe_identifiersArrayA list of permitted universe identifiers (e.g., ["AAPL", "MSFT"]). If the list is empty, there are no universe restrictions.

Three layered checks: identity, IP, entitlement​

When you send a request, the server runs three checks in order.

1. Identity.​

Is the value in X-API-KEY a known, active key? If not (if it is missing, malformed, deactivated, or just a typo) the server returns 401 Unauthorized.

2. IP whitelist.​

Is the source IP of the request on the allow-list configured for this key? If not, you get 403 Forbidden. The allow-list is per-account and is configured out of band. The IP is not available for Sandbox users.

3. Access Rules.​

Is the dataset you are asking about included in this key's data-access rules? If not, you get 403 Forbidden with a payload like {"detail":"The account is not authorized to access the dataset ..."}.

Note

The first two checks happen on the edge, before the request hits the application, but the entitlement check runs after request parsing, so a 4xx coming back may be from either layer, and your client must read the response body to be sure which.

Access Rule Examples​

Example: 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. The end date is null, indicating that the access is ongoing for daily updates.

{
  "dataset_id": "US1032",
  "dataset_name": "US Equities Trade and Quote",
  "dataset_version": "1.0",
  "start_date": "2007-01-01",
  "end_date": null,
  "universe_identifiers": []
}

Example: 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_id": "US2050",
  "dataset_name": "US Options Trade and NBBO Quote",
  "dataset_version": "1.0",
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "universe_identifiers": ["AAPL", "MSFT", "IBM"]
}