Get Credit Balance

Get the current credit balance for your API key. When using the test API key (or no API key) this just returns a random number of credits as an example.

To use your API key you can either add the apiKey parameter to the URL or supply a X-API-KEY header with your API key as the header value to your request. The simplest option in most cases is just adding the URL parameter.

OpenAPI Specification

https://api.scrapi.tech/scalar/v1#tag/balance/GET/v1/balance

Endpoint

GET https://api.scrapi.tech/v1/balance?apiKey=00000000-0000-0000-0000-000000000000

JSON Response

The response data contains a single property for the number of API credits remaining for the supplied API key.

{
  "credits": 85433
}