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

# Read wallet balance

> Returns the authenticated caller's wallet balance and currency. Authenticate with the `api-token` header. The email is derived server-side from the auth identity, so a token can only ever read its own wallet (IDOR-safe).

By default this is an O(1) wallet primary-key lookup (`balance` + `currency` only). Pass `include_counts=1` to also return `topups_count` and `purchases_count` (email-scoped compound indexes on orders).

Gated on `account:api_ordering:read` for API keys (admin-grant-only; off by default).



## OpenAPI

````yaml /openapi-account.json get /v4/account/orders/balance
openapi: 3.0.3
info:
  title: ProxyScrape Account API
  description: Account API — authenticate with the api-token header.
  version: 1.0.0
servers:
  - url: https://api.proxyscrape.com
    description: ProxyScrape API
security:
  - apiToken: []
tags:
  - name: API key management
    description: Create, list, update, regenerate, and revoke API keys
  - name: Subaccounts
    description: List subaccounts and manage preferences
  - name: Datacenter
    description: 'Datacenter shared and dedicated: overview, proxy list, usage, whitelist'
  - name: Residential
    description: 'Residential (bandwidth): overview, subusers, usage'
  - name: Residential unlimited
    description: 'Residential unlimited: overview, statistics, password'
  - name: SERP API
    description: 'SERP API: overview, subusers, search'
  - name: API ordering
    description: >-
      Place wallet-paid orders and read the wallet balance via the headless API
      ordering surface.
paths:
  /v4/account/orders/balance:
    get:
      tags:
        - API ordering
      summary: Read wallet balance
      description: >-
        Returns the authenticated caller's wallet balance and currency.
        Authenticate with the `api-token` header. The email is derived
        server-side from the auth identity, so a token can only ever read its
        own wallet (IDOR-safe).


        By default this is an O(1) wallet primary-key lookup (`balance` +
        `currency` only). Pass `include_counts=1` to also return `topups_count`
        and `purchases_count` (email-scoped compound indexes on orders).


        Gated on `account:api_ordering:read` for API keys (admin-grant-only; off
        by default).
      operationId: getApiOrderBalance
      parameters:
        - name: include_counts
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            When true, include `topups_count` and `purchases_count` in the
            response. Omit for the lightweight balance-only read used by
            checkout.
      responses:
        '200':
          description: Wallet balance (and optional activity counts).
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      balance:
                        type: number
                        format: float
                        example: 42.5
                      currency:
                        type: string
                        example: USD
                      topups_count:
                        type: integer
                        example: 8
                        description: >-
                          Processed wallet top-ups. Present only when
                          include_counts=1.
                      purchases_count:
                        type: integer
                        example: 30
                        description: >-
                          Wallet-credit purchases excluding cancelled/refunded.
                          Present only when include_counts=1.
              examples:
                balance_only:
                  summary: Default (balance only)
                  value:
                    success: true
                    data:
                      balance: 42.5
                      currency: USD
                with_counts:
                  summary: With include_counts=1
                  value:
                    success: true
                    data:
                      balance: 42.5
                      currency: USD
                      topups_count: 8
                      purchases_count: 30
        '401':
          description: Missing or invalid credentials.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: >-
                      Could not determine account email from authenticated
                      identity.
        '403':
          description: >-
            Balance read is not enabled for this account. Contact support to
            request the `account:api_ordering:read` grant.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: >-
                      Reading the wallet balance via the API-ordering endpoint
                      is not enabled for this account. Contact support to
                      request access.
      security:
        - apiToken: []
components:
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: api-token
      description: >-
        API key. Create and manage keys at /v4/account/api-keys or in the
        dashboard.

````