API reference

Account

Your prepaid balance, every movement on it, and the free search allowance left for today.

Operations

OperationWhat it doesScope
GET/v1/account/ledgerYour prepaid balanceledger:read
GET/v1/account/ledger/entriesEvery movement on your account, newest firstledger:read
GET/v1/account/quotaSearches used today, and what is left of the free allowanceaccount:read

A key that lacks one of these scopes is refused with 403 insufficient_scope, and error.missingScope names the one it was missing. Scopes are fixed when the key is issued.

Shared across these operations

The error envelope and the full list of error types are the same for every operation in the API, as are the object schemas the responses are built from. Neither is repeated per page.