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

# Get API usage

> Returns account-level API usage for the current entitlement period. Any active gHypurr API key can authenticate this endpoint.



## OpenAPI

````yaml /openapi/ghypurr-v1.json get /api/v1/usage
openapi: 3.1.0
info:
  title: gHypurr Public API
  version: 1.0.0
  description: >-
    Read-only access to gHypurr News, Smart Money, Meme Signals, Published AI
    Signals, and account usage. API keys are created in the authenticated
    gHypurr account interface.
  license:
    name: gHypurr API Terms
    url: https://ghypurr.com/legal/api_terms
servers:
  - url: https://ghypurr.com
    description: Production
security:
  - GhypurrApiKey: []
tags:
  - name: News
    description: Published market-news data.
  - name: Smart Money
    description: Public Smart Money wallet research rows.
  - name: Meme
    description: Published meme-token alerts.
  - name: AI Signals
    description: Already-published, read-only AI signal snapshots.
  - name: Account
    description: API usage for the authenticated account.
paths:
  /api/v1/usage:
    get:
      tags:
        - Account
      summary: Get API usage
      description: >-
        Returns account-level API usage for the current entitlement period. Any
        active gHypurr API key can authenticate this endpoint.
      operationId: getApiUsage
      responses:
        '200':
          description: Current plan and usage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '503':
          $ref: '#/components/responses/Unavailable'
components:
  schemas:
    UsageResponse:
      type: object
      additionalProperties: false
      required:
        - plan
        - usage
      properties:
        plan:
          type: string
          enum:
            - pro
            - elite
        usage:
          $ref: '#/components/schemas/Usage'
    Usage:
      type: object
      additionalProperties: false
      required:
        - periodStartedAt
        - periodEndsAt
        - data
        - aiSignals
      properties:
        periodStartedAt:
          type: string
          format: date-time
        periodEndsAt:
          type: string
          format: date-time
        data:
          $ref: '#/components/schemas/UsageBucket'
        aiSignals:
          $ref: '#/components/schemas/UsageBucket'
    Error:
      type: object
      additionalProperties: false
      required:
        - error
        - message
      properties:
        error:
          type: string
          example: invalid_api_key
        message:
          type: string
          example: API key is invalid or inactive
    UsageBucket:
      type: object
      additionalProperties: false
      required:
        - used
        - limit
        - remaining
      properties:
        used:
          type: integer
          minimum: 0
        limit:
          type: integer
          minimum: 0
        remaining:
          type: integer
          minimum: 0
  responses:
    Unauthorized:
      description: The Bearer API key is absent, malformed, invalid, expired, or inactive.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The key lacks the required scope or the request IP is not allowed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unavailable:
      description: A required API service is temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    GhypurrApiKey:
      type: http
      scheme: bearer
      bearerFormat: opaque API key
      description: >-
        Create a scoped key at https://ghypurr.com/account/api-keys. Never place
        a real key in documentation or client-side source.

````