---
title: "Get this key’s usage and limits"
method: GET
path: "/v1/usage"
---

# Get this key’s usage and limits

`GET /v1/usage`

## Request

- Base URL: `https://api.typesearch.ai`
- URL: `https://api.typesearch.ai/v1/usage`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

## Response `200`

The usage.

- Usage
  - `object` 'usage', required
  - `key` object, required
    - `id` string, required
    - `name` string, required
  - `limits` object, required
    - `tokens_per_day` integer, required
    - `requests_per_minute` integer, required
    - `requests_per_second` integer, nullable, required
  - `today` object, required
    - `requests` integer, required
    - `tokens` integer, required
    - `cost_usd` number, required
    - `remaining_tokens` integer, required
  - `last_30_days` object, required
    - `requests` integer, required
    - `tokens` integer, required
    - `cost_usd` number, required
  - `credit` object, nullable, required: The organization credit behind this key. Null for internal keys, which are not billed.
    - `balance_usd` number, required
    - `plan` 'payg' | 'plan', required
    - `spent_this_month_usd` number, required
    - `monthly_limit_usd` number, nullable, required
  - `pricing` object, required: The list prices: per 1,000 requests for each search mode, similar and live site search (each query in a multi-query request is one search of its mode), per 1,000 pages for contents, per 1,000 URLs per month for custom indexes, and per 1,000 charts.
    - `currency` 'USD', required
    - `per_1000_requests` object, required
      - `ultra` number, required
      - `fast` number, required
      - `normal` number, required
      - `deep` number, required
      - `similar` number, required
      - `similar_deep` number, required: Similar in deep mode, which reads eight articles and returns highlights.
      - `site_search` number, required
    - `per_1000_pages` object, required
      - `contents` number, required
      - `contents_with_query` number, required: With a query, the model reads each page and picks the excerpts.
    - `per_1000_urls_per_month` object, required
      - `custom_index` number, required: Each URL in your custom indexes, billed daily (a thirtieth per day); searches over them cost their mode.
    - `per_1000_charts` object, required
      - `query_addon` number, required: A chart from a query: its search (the mode, per query) plus this.
      - `from_data` number, required: A chart from your own data.

## Other responses

- `402`: Payment required: `insufficient_credits` (no credit left), `spend_limit_reached` (the key hit its monthly limit) or `budget_too_small`.
- `default`: Error (RFC 9457). In English unless the request sends `Accept-Language: es`.

---

[API](https://skmtc.dev/typesearch/apis/typesearch-news-search-api.md) · [All operations](https://skmtc.dev/typesearch/apis/typesearch-news-search-api/llms.txt) · [OpenAPI document](https://skmtc.dev/typesearch/apis/typesearch-news-search-api/revisions/b270b9a9c6a5?raw)