---
title: "Read wallet balance"
method: GET
path: "/v4/account/orders/balance"
tags: ["API ordering"]
---

# Read wallet balance

`GET /v4/account/orders/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).

## Query parameters

- `include_counts` boolean

## Response `200`

Wallet balance (and optional activity counts).

- object
  - `success` boolean
  - `data` object
    - `balance` number, float
    - `currency` string
    - `topups_count` integer — Processed wallet top-ups. Present only when include_counts=1.
    - `purchases_count` integer — Wallet-credit purchases excluding cancelled/refunded. Present only when include_counts=1.

## Other responses

- `401` — Missing or invalid credentials.
- `403` — Balance read is not enabled for this account. Contact support to request the `account:api_ordering:read` grant.

---

[API](https://skmtc.net/proxyscrape/apis/proxyscrape-account-api.md) · [All operations](https://skmtc.net/proxyscrape/apis/proxyscrape-account-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/proxyscrape/proxyscrape-account-api/revisions/4e10267785e1/schema)
