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

# Retrieve the balance



## OpenAPI

````yaml /openapi.json get /v1/balance
openapi: 3.1.0
info:
  title: Hooper API
  version: 1.0.0
  description: >-
    Submit basketball game video and receive highlights, shots and per-player
    box scores.


    All endpoints require `Authorization: Bearer hk_prod_…`. Money fields are
    integer **cents**. Timestamps are Unix seconds. Every list — top-level or
    embedded — is `{ object: "list", data, has_more, total_count }`.
servers:
  - url: https://api.hooper.gg
    description: Production (accepts hk_prod_ keys)
security:
  - apiKey: []
tags:
  - name: Uploads
    description: Resumable video uploads to Hooper storage.
  - name: Sessions
    description: >-
      A session is one submitted game and everything the pipeline produced for
      it.
  - name: Billing
    description: Prepaid credits, metered per second of video.
  - name: Webhooks
    description: Signed HTTP callbacks when a session finishes.
  - name: Events
    description: The log of every event Hooper has emitted for your organization.
paths:
  /v1/balance:
    get:
      tags:
        - Billing
      summary: Retrieve the balance
      operationId: getBalance
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Balance:
      type: object
      properties:
        object:
          type: string
          const: balance
        currency:
          type: string
          const: usd
        available_cents:
          type: integer
          description: Credits minus open holds.
        held_cents:
          type: integer
        credit_cents:
          type: integer
        rate_cents_per_hour:
          type: integer
          example: 500
        soonest_expiry:
          type: integer
          nullable: true
          description: Unix seconds when the balance next shrinks on its own.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - insufficient_credits
                - rate_limit_error
                - api_error
            code:
              type: string
              example: parameter_invalid
            message:
              type: string
            param:
              type: string
              description: The request field the error refers to, when there is one.
              example: source.url
  responses:
    Unauthorized:
      description: Missing, invalid, revoked or wrong-environment API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: hk_prod_… / hk_stg_…
      description: >-
        API key issued by Hooper for your organization. Keys are
        environment-tagged: `hk_prod_` keys work against production, `hk_stg_`
        keys against staging.

````