---
title: "Effective Public API Access for This Key"
method: GET
path: "/v1/usage/access"
tags: ["Usage"]
---

# Effective Public API Access for This Key

`GET /v1/usage/access`

## Request

- Base URL: `https://api.tlmtr.io`
- URL: `https://api.tlmtr.io/v1/usage/access`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/tlmtr/apis/telemetr-io-public-api/docs/v1/usage/access/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the current operation-level access and locally enforced limits for
the authenticated API key. It does not consume request quota or credits and
remains available when a valid key's subscription is inactive.

## Response `200`

Effective API operation access and limits

- AccessInfo
  - `schema_version` integer, required
  - `user_id` string, required: Opaque owner identifier for the authenticated API key. Legacy identifiers may be numeric Telegram IDs rather than account IDs.
  - `key_type` 'credits' | 'subscription', required
  - `active` boolean, required
  - `operations` OperationAccess[], required
    - `operation_id` string, required
    - `method` string, required
    - `path` string, required
    - `allowed` boolean, required
    - `denial_code` 'inactive_subscription' | 'capability_disabled' | 'feature_unavailable'
    - `required_capability` string, nullable
  - `limits` EffectiveLimits, required
    - `allow_messages_search` boolean, required
    - `allow_links_in_search` boolean, required
    - `only_verified` boolean, required
    - `allow_catalog` boolean, required
    - `allow_catalog_snapshots` boolean, required
    - `catalog_snapshots_limit` integer, required
    - `catalog_diffs_limit` integer, required
    - `catalog_snapshot_max_channels` integer, required
    - `max_chart_days` integer, required
    - `max_posts_days` integer, required
    - `max_mentions_days` integer, required
    - `search_limit` integer, required
    - `messages_limit` integer, required
    - `max_search_messages_days` integer, required

## Other responses

- `400`: **Bad Request:** The request sent to the server is invalid. Request parameters are missing, incorrect, or in the wrong format.
- `401`: **Unauthorized:** The provided API key is invalid or absent. Provided in the request API key is not valid or is missing.
- `402`: **Payment Required:** Not enough credits to perform this request. The plan allows this call but the credit balance does not cover it. Top up credits and retry. Amounts are in milli-credits (1 credit = 1000).
- `403`: **Forbidden:** Access to this resource is not allowed. User does not have permission to access this feature.
- `404`: **Not Found:** Requested resource could not be found on the server. Specific resource with the provided ID cannot be found.
- `412`: **Inactive Subscription:** The user's subscription is not currently active. User subscription has expired or is otherwise inactive.
- `426`: **Quota Reached:** The user's subscription limit has been reached. User has exceeded their monthly limit for unique channels or total requests. For higher limits please contact us via Telegram [@telemetrio_contact](https://t.me/telemetrio_contact) or write to contact@telemetr.io.
- `429`: **Too Many Requests:** The request rate limit has been reached. Retry after the interval indicated by the response headers.
- `503`: **Service Unavailable:** Credit accounting is temporarily unreachable. The request was refused rather than served without being billed. This is transient — retry with backoff. Carries the standard message envelope, with a constant message: the underlying failure is ours and its text names internal machinery, so it is never forwarded.

## Changes

- **2026-11-10** `98f399867856`: 1 info
  - added the required property `user_id` to the response with the `200` status
- **2026-10-09** `6c2bfd66c5f2`: 8 breaking, 2 info
  - the response's body type changed from `object` to no type for status `402`
  - the response's body type changed from `object` to no type for status `426`
  - removed the required property `available_mc` from the response with the `402` status
  - removed the required property `limit` from the response with the `426` status
  - …6 more
- **2026-09-24** `2f9bd490eb3c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/tlmtr/apis/telemetr-io-public-api/changes/v1/usage/access/get.md)

---

[API](https://skmtc.dev/tlmtr/apis/telemetr-io-public-api.md) - [All operations](https://skmtc.dev/tlmtr/apis/telemetr-io-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tlmtr/apis/telemetr-io-public-api/revisions/98f399867856?raw)