# Source: https://docs.tavily.com/documentation/api-reference/endpoint/usage.md

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tavily.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

> Get API key and account usage details



## OpenAPI

````yaml GET /usage
openapi: 3.0.3
info:
  title: Tavily Search and Extract API
  description: >-
    Our REST API provides seamless access to Tavily Search, a powerful search
    engine for LLM agents, and Tavily Extract, an advanced web scraping solution
    optimized for LLMs.
  version: 1.0.0
servers:
  - url: https://api.tavily.com/
security: []
tags:
  - name: Search
  - name: Extract
  - name: Crawl
  - name: Map
  - name: Research
  - name: Usage
paths:
  /usage:
    get:
      summary: Get API key and account usage details
      description: Get API key and account usage details
      responses:
        '200':
          description: Usage details returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  key:
                    type: object
                    properties:
                      usage:
                        type: integer
                        description: >-
                          Total credits used for this API key during the current
                          billing cycle
                        example: 150
                      limit:
                        type: integer
                        description: Usage limit for the API key. Returns null if unlimited
                        example: 1000
                      search_usage:
                        type: integer
                        description: >-
                          Search endpoint credits used for this API key during
                          the current billing cycle
                        example: 100
                      extract_usage:
                        type: integer
                        description: >-
                          Extract endpoint credits used for this API key during
                          the current billing cycle
                        example: 25
                      crawl_usage:
                        type: integer
                        description: >-
                          Crawl endpoint credits used for this API key during
                          the current billing cycle
                        example: 15
                      map_usage:
                        type: integer
                        description: >-
                          Map endpoint credits used for this API key during the
                          current billing cycle
                        example: 7
                      research_usage:
                        type: integer
                        description: >-
                          Research endpoint credits used for this API key during
                          the current billing cycle
                        example: 3
                  account:
                    type: object
                    description: Account plan and usage information
                    properties:
                      current_plan:
                        type: string
                        description: The current subscription plan name
                        example: Bootstrap
                      plan_usage:
                        type: integer
                        description: >-
                          Total credits used for this plan during the current
                          billing cycle
                        example: 500
                      plan_limit:
                        type: integer
                        description: Usage limit for the current plan
                        example: 15000
                      paygo_usage:
                        type: integer
                        description: Current pay-as-you-go usage count
                        example: 25
                      paygo_limit:
                        type: integer
                        description: Pay-as-you-go usage limit
                        example: 100
                      search_usage:
                        type: integer
                        description: >-
                          Search endpoint credits used for this plan during the
                          current billing cycle
                        example: 350
                      extract_usage:
                        type: integer
                        description: >-
                          Extract endpoint credits used for this plan during the
                          current billing cycle
                        example: 75
                      crawl_usage:
                        type: integer
                        description: >-
                          Crawl endpoint credits used for this plan during the
                          current billing cycle
                        example: 50
                      map_usage:
                        type: integer
                        description: >-
                          Map endpoint credits used for this plan during the
                          current billing cycle
                        example: 15
                      research_usage:
                        type: integer
                        description: >-
                          Research endpoint credits used for this plan during
                          the current billing cycle
                        example: 10
        '401':
          description: Unauthorized - Your API key is wrong or missing.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: object
                    properties:
                      error:
                        type: string
              example:
                detail:
                  error: 'Unauthorized: missing or invalid API key.'
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer authentication header in the form Bearer <token>, where <token>
        is your Tavily API key (e.g., Bearer tvly-YOUR_API_KEY).

````