---
title: "Get API key and account usage details"
method: GET
path: "/usage"
---

# Get API key and account usage details

`GET /usage`

Get API key and account usage details

## Headers

- `X-Project-ID` string

## Response `200`

Usage details returned successfully

- object
  - `key` object
    - `usage` integer — Total credits used for this API key during the current billing cycle
    - `limit` integer — Usage limit for the API key. Returns null if unlimited
    - `search_usage` integer — Search endpoint credits used for this API key during the current billing cycle
    - `extract_usage` integer — Extract endpoint credits used for this API key during the current billing cycle
    - `crawl_usage` integer — Crawl endpoint credits used for this API key during the current billing cycle
    - `map_usage` integer — Map endpoint credits used for this API key during the current billing cycle
    - `research_usage` integer — Research endpoint credits used for this API key during the current billing cycle
  - `account` object — Account plan and usage information
    - `current_plan` string — The current subscription plan name
    - `plan_usage` integer — Total credits used for this plan during the current billing cycle
    - `plan_limit` integer — Usage limit for the current plan
    - `paygo_usage` integer — Current pay-as-you-go usage count
    - `paygo_limit` integer — Pay-as-you-go usage limit
    - `search_usage` integer — Search endpoint credits used for this plan during the current billing cycle
    - `extract_usage` integer — Extract endpoint credits used for this plan during the current billing cycle
    - `crawl_usage` integer — Crawl endpoint credits used for this plan during the current billing cycle
    - `map_usage` integer — Map endpoint credits used for this plan during the current billing cycle
    - `research_usage` integer — Research endpoint credits used for this plan during the current billing cycle

## Other responses

- `401` — Unauthorized - Your API key is wrong or missing.
- `429` — Too Many Requests

---

[API](https://skmtc.net/tavily/apis/tavily-search-and-extract-api.md) · [All operations](https://skmtc.net/tavily/apis/tavily-search-and-extract-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tavily/tavily-search-and-extract-api/versions/9126e7d2df75/schema)
