Credits

Read the live account balance using an 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.

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

Response

Signed balance and nonnegative available Credits

scope'account' required
unit'Credits' required
balanceCreditsnumber required

Signed live balance; in-flight reservations may already be reflected.

availableCreditsnumber required

max(balanceCredits, 0).

updatedAtstring nullable required
notestring required

Changes

No recorded changes to this operation across all 1 revision of this API.