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

# Utils - Credits Usage of current account

> Retrieve credit usage of current account.

<Tabs>
  <Tab title="Usage Note">
    <p><strong>Current-cycle or bounded credit-usage report for the authenticated account.</strong></p>

    <ul>
      <li>Maximum <code>time\_from</code> to <code>time\_to</code> span is one year.</li>
      <li>If <code>time\_from</code> and <code>time\_to</code> are omitted, the endpoint returns the current billing-cycle view.</li>
      <li>If the requested range falls outside the current cycle, <code>remaining</code>, <code>overage\_usage</code>, and <code>overage\_cost</code> return <code>null</code>.</li>
    </ul>
  </Tab>

  <Tab title="Accessibility">
    <ul>
      <li>Standard</li>
      <li>Lite</li>
      <li>Starter</li>
      <li>Premium</li>
      <li>Business</li>
      <li>Enterprise</li>
    </ul>
  </Tab>

  <Tab title="Chain Supported">
    <p><strong>All chains ⛓️ ✨</strong></p>
  </Tab>
</Tabs>

<Accordion title="Compute Unit ⚙️" icon="fa-gauge-high">
  <ul>
    <li>This endpoint consumes <code>1 CU</code> per request.</li>
  </ul>
</Accordion>

<Accordion title="Use Cases 💡" icon="fa-lightbulb">
  <ul>
    <li>Monitor current credit consumption for one API account.</li>
    <li>Build internal usage dashboards and overage alerts.</li>
    <li>Reconcile product usage with subscription or billing state.</li>
  </ul>
</Accordion>

<Accordion title="How to Use 🛠️" icon="fa-book-open">
  <ul>
    <li>Call without time parameters for the current cycle.</li>
    <li>Add <code>time\_from</code> and <code>time\_to</code> when you need a bounded historical slice within the supported range.</li>
  </ul>
</Accordion>

<Accordion title="Best Practices ✅" icon="fa-check-circle">
  <ul>
    <li>Poll lightly and cache for ops dashboards; usage does not need market-data refresh frequency.</li>
    <li>Treat <code>null</code> overage or remaining fields as “outside current cycle,” not as zero.</li>
  </ul>
</Accordion>

<br />


## OpenAPI

````yaml openapi/data/openapi_docs.json GET /utils/v1/credits
openapi: 3.1.0
info:
  version: 1.1.0
  title: Birdeye Data API
  description: >-
    Birdeye Data API is a full-spectrum blockchain and DEX data platform for
    teams that need production-grade crypto market intelligence across tokens,
    pairs, wallets, traders, protocols, and chains.


    From real-time prices, OHLCV, liquidity, and transaction flow to holder
    analytics, token and pair overviews, wallet portfolio and PnL, smart money,
    discovery, security, and blockchain-level utilities, Birdeye gives you a
    unified data layer for building serious crypto products at scale.


    Use it to power exchange interfaces, trading terminals, bots, market-making
    systems, quant research, alpha screeners, portfolio apps, wallet
    intelligence tools, alerting systems, analytics dashboards, and back-office
    data pipelines. Whether your users are retail traders, pro desks, analysts,
    or infrastructure teams, Birdeye helps you ship faster with broad market
    coverage and API surfaces that support both lightweight integrations and
    data-heavy workflows.


    To start, create an account at [bds.birdeye.so](https://bds.birdeye.so),
    generate an API key from the `Security` tab, and send it in the `X-API-KEY`
    header on every request.
servers:
  - url: https://public-api.birdeye.so
security:
  - apiKeyAuth: []
tags:
  - name: Price & OHLCV
  - name: Stats
  - name: Token/Market List
  - name: Transactions
  - name: Wallet, Networth & PnL
  - name: Balance & Transfer
  - name: Holder
  - name: Alltime & History
  - name: Blockchain
  - name: Account
  - name: Token
  - name: Transaction
  - name: Creation & Trending
  - name: Meme
  - name: Security
  - name: Search & Utils
  - name: Smart Money
  - name: Global Fees Paid
  - name: DEX & Protocol
  - name: Wallet Identity
paths:
  /utils/v1/credits:
    get:
      tags:
        - Search & Utils
      summary: Utils - Credits Usage of current account
      description: Retrieve credit usage of current account.
      operationId: get-utils-v1-credits
      parameters:
        - $ref: '#/components/parameters/optionalTimeFromParam'
        - $ref: '#/components/parameters/optionalTimeToParam'
      responses:
        '200':
          $ref: '#/components/responses/UtilsCreditsUsage'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
components:
  parameters:
    optionalTimeFromParam:
      name: time_from
      description: Specify the start time using unix timestamps in seconds
      in: query
      required: false
      schema:
        type: integer
        minimum: 0
        maximum: 10000000000
      example: 1726700000
    optionalTimeToParam:
      name: time_to
      description: Specify the end time using unix timestamps in seconds
      in: query
      required: false
      schema:
        type: integer
        minimum: 0
        maximum: 10000000000
      example: 1726704000
  responses:
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Bad request
    '401':
      description: Unauthorized. API key is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Unauthorized
    '403':
      description: Forbidden. Request is blacklisted or not whitelisted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Access Denied
    '429':
      description: Too Many Requests. Rate limit reached
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Too many requests
    '500':
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Internal Server Error
    UtilsCreditsUsage:
      description: JSON object containing the credits usage
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UtilsCreditsUsageResponse'
          examples:
            CreditsUsage:
              value:
                data:
                  start_time: 1758367608
                  end_time: 1760959608
                  usage:
                    total: 1176300
                    api: 1162912
                    ws: 13388
                  remaining:
                    api: 1498837088
                    ws: 49986612
                    total: 1548823700
                  overage_usage:
                    api: 0
                    ws: 0
                    total: 0
                  overage_cost:
                    api: 0
                    ws: 0
                    total: 0
                success: true
  schemas:
    UtilsCreditsUsageResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          description: Whether the request completed successfully.
        data:
          type: object
          description: Credit usage and remaining balance for the current account.
          required:
            - start_time
            - end_time
            - usage
          properties:
            start_time:
              type: integer
              description: Start of the credit usage window as a Unix timestamp.
            end_time:
              type: integer
              description: End of the credit usage window as a Unix timestamp.
            usage:
              type: object
              description: Credit usage totals.
              required:
                - api
                - ws
                - total
              properties:
                api:
                  type: integer
                  description: API credits used.
                ws:
                  type: integer
                  description: WebSocket credits used.
                total:
                  type: integer
                  description: Total credits used.
            remaining:
              type: object
              description: Remaining credits in the account.
              required:
                - api
                - ws
                - total
              properties:
                api:
                  type: integer
                  description: Remaining API credits.
                ws:
                  type: integer
                  description: Remaining WebSocket credits.
                total:
                  type: integer
                  description: Total remaining credits.
            overage_usage:
              type: object
              description: Credits consumed beyond the plan allowance.
              required:
                - api
                - ws
                - total
              properties:
                api:
                  type: integer
                  description: Overage API credits used.
                ws:
                  type: integer
                  description: Overage WebSocket credits used.
                total:
                  type: integer
                  description: Total overage credits used.
            overage_cost:
              type: object
              description: Estimated overage cost by channel.
              required:
                - api
                - ws
                - total
              properties:
                api:
                  type: integer
                  description: Overage cost for API usage.
                ws:
                  type: integer
                  description: Overage cost for WebSocket usage.
                total:
                  type: integer
                  description: Total overage cost.
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API key for authentication

````