Skip to main content

Check API Usage Quotas and Rate Limits

The algoseek Datasets API uses API Keys to authenticate requests. Furthermore, access is governed by IP whitelisting, specific dataset access rules, and usage quotas.

How to Authenticate​

You must pass your API key in the header of every request using the X-API-KEY field.

Verifying Your Identity and Access​

The API provides several endpoints under the Identity & Access tag to help you manage your authorization status:

  • Check Identity: GET /v1/account/my returns details about the identity owning the API key, including allowed IP subnets.
  • Check Quotas: GET /v1/account/my/quotas returns your API usage summary for the current month and minute against your limits.
Note

Quotas are applied across all API keys and identities in your team.

  • Check Dataset Permissions: GET /v1/account/my/data-access-rules lists the specific datasets you are authorized to access, including th start date and list of identifiers.

Managing Quotas​

Keeping track of your API consumption is essential for maintaining uninterrupted service and optimizing your data workflows. The Quotas Endpoint provides developers with real-time visibility into their account limits and current activity. Whether you need to debug rate-limiting issues, monitor your per-minute request rate, or simply track your data scanning and retrieval metrics for the month, the following guide outlines how to securely and easily retrieve your usage statistics.

Endpoint: GET /v1/account/my/quotas

What it does: Returns your API usage summary for the current month and minute, along with your usage limits:

  • the number of requests
  • the amount of data returned (bytes)
Info

Data returned is the amount of data retrieved from the engine used to generate the response.

Request example:

curl --get \
    'https://api.algoseek.com/v1/account/my/quotas' \
     -H "X-API-KEY: YOUR_API_KEY"

Response example:

{
    "quotas_usage": {
        "per_minute_requests": 1,
        "monthly_requests": 473,
        "monthly_data_returned": 82934350
    },
    "quotas_limit": {
        "per_minute_requests": 1000,
        "monthly_requests": 1000000,
        "monthly_data_returned": 100000000000
    }
}

The monthly quota resets at 00:00 UTC on the first day of the month and the minute quota resets at the start of each minute.

Note

The quota limits and usage applies on the account level, so it includes usage across all API keys in the account.