Read your balance
Read account funds, current reservations and whether paid calls are allowed.
View as MarkdownEndpoint
All balance amounts are USD micro-unit integer strings. availableMicros is available for new requests, heldMicros is reserved, and balanceMicros is the account balance. asOf is the response timestamp.
paidCallsAllowed reports account eligibility for paid calls; it is not a quote or guarantee that a particular Run fits its budget. Run-level caps and account limits still apply.
GET /v1/balanceRequest example
Set PURRKEY_API_KEY in your trusted server or terminal environment. Replace any angle-bracket placeholders with values from your own inspection or Run.
curl --fail-with-body --request GET 'https://api.purrkey.app/v1/balance' \
-H "Authorization: Bearer $PURRKEY_API_KEY"Successful response
Success HTTP status: 200. Top-level response fields are listed below. Conditional and nested requirements are defined in the downloadable OpenAPI contract.
| Field | Type | Required | Constraints |
|---|---|---|---|
| currency | string | Required | USD |
| balanceMicros | string | Required | Pattern: ^-?[0-9]+$ |
| availableMicros | string | Required | Pattern: ^[0-9]+$ |
| heldMicros | string | Required | Pattern: ^[0-9]+$ |
| paidCallsAllowed | boolean | Required | — |
| asOf | string | Required | date-time |