---
title: "Returns the caller's current credit balance."
method: GET
path: "/api/wallet"
tags: ["wallet"]
---

# Returns the caller's current credit balance.

`GET /api/wallet`

## Request

- Base URL: `https://api.pricklymails.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pricklymails.com/api/wallet`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Response `200`

Current credit balance.

- WalletBalanceResponse: JSON response body for `GET /api/wallet`.
  - `available` integer, required: Tokens available for immediate use.
  - `avg_daily_spend` integer, required: Mean daily spend (committed plus debited tokens) over the last 30 days, rounded down.
  - `reserved` integer, required: Tokens reserved by in-flight jobs.
  - `total` integer, required: Total tokens (available + reserved), capped at 4294967295.
  - `updated_at` string, date-time, required: Timestamp of the last balance update.

## Other responses

- `401`: Missing or invalid API key, session token, or agent token.
- `403`: The key or agent token lacks the `billing:read` scope.

---

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