Skip to main content
GET
Credits

Authentication

Requires an API key in the Authorization header.

Request

No parameters required. The balance is scoped to the API key’s active workspace when one is selected, otherwise to the key owner’s account.

Response

number
Credits currently available to spend.
number
Total credits consumed to date.
number
Total number of lookups performed to date.

Errors

Errors return a JSON body of the form {"error": "<message>"} with the matching HTTP status code.