---
title: "Read the live account balance using an API key"
method: GET
path: "/api-access/balance"
tags: ["Credits"]
---

# Read the live account balance using an API key

`GET /api-access/balance`

## Request

- Base URL: `https://api.flashdata.dev/v2`
- URL: `https://api.flashdata.dev/v2/api-access/balance`
- Auth: API key in header `X-API-Key`

Free X-API-Key read of the authenticated account's Redis balance, shared by
all account keys. In-flight reservations can affect the balance. Does not
fabricate reservedCredits, fall back to Mongo, or turn failures into zero.
No query parameters or request body. Shares the /api-access read limit;
responses are private, no-store. Does not reserve or spend Credits.

## Response `200`

Signed balance and nonnegative available Credits

- ApiAccessBalance
  - `scope` 'account', required
  - `unit` 'Credits', required
  - `balanceCredits` number, required: Signed live balance; in-flight reservations may already be reflected.
  - `availableCredits` number, required: max(balanceCredits, 0).
  - `updatedAt` string, nullable, required
  - `note` string, required

## Other responses

- `401`: Authentication required or invalid
- `422`: Request validation failed
- `429`: Too many account reads; retry after the rate-limit window
- `503`: A required dependency or catalog is temporarily unavailable

---

[API](https://skmtc.dev/flashdata/apis/flashdata-customer-api.md) · [All operations](https://skmtc.dev/flashdata/apis/flashdata-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flashdata/apis/flashdata-customer-api/revisions/109179fe9313?raw)