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

# Balance and key limits

> Free. Requires billing:read.



## OpenAPI

````yaml /openapi/apiosk-api.json get /v2/balance
openapi: 3.1.0
info:
  title: Apiosk API
  version: 2.0.0
  description: >-
    Buy verifiable data per call with an organisation API key. Discover sources,
    run one directly, or let Apiosk plan across sources. Amounts are USD; every
    amount carries an exact micro-USD integer.
servers:
  - url: https://gateway.apiosk.com
security:
  - apiKey: []
paths:
  /v2/balance:
    get:
      summary: Balance and key limits
      description: Free. Requires billing:read.
      operationId: getBalance
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  organisation_id:
                    type: string
                    format: uuid
                  balance:
                    type: object
                    properties:
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                  key:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      scopes:
                        type: array
                        items:
                          type: string
                      expires_at:
                        type: string
                        format: date-time
                  limits:
                    type: object
                    properties:
                      per_request:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      monthly:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      month_spent:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      month_remaining:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      month_start:
                        type: string
                        format: date-time
        '401':
          description: invalid_api_key, api_key_expired or api_key_revoked
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
        '403':
          description: insufficient_scope or organisation_unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
        '429':
          description: rate_limit_exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
        '503':
          description: service_unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An organisation API key: Authorization: Bearer apk_org_live_…'

````