Check Credit Balance

Retrieve the current number of credits remaining for your API key. Use this endpoint to monitor usage, trigger alerts when credits run low, or display balance information in your application’s dashboard.

When using the test API key (or no API key), this endpoint returns a random number as an example.

When To Use This

Usage monitoring - Poll your balance periodically to track credit consumption across scraping jobs.
Low-balance alerts - Build automated alerts that notify you when credits drop below a threshold, so you can top up before workflows fail.
Dashboard integration - Display real-time credit balance in your application’s admin panel or monitoring dashboard.
Cost tracking - Compare balance before and after batch jobs to measure credit consumption per workflow.

Authentication

Authenticate using either method:

URL parameter: ?apiKey=00000000-0000-0000-0000-000000000000
Request header: X-API-KEY: 00000000-0000-0000-0000-000000000000

OpenAPI Specification

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

Endpoint

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

JSON Response

{
  "credits": 85433
}

The credits field contains the number of API credits remaining for the authenticated API key.

Credit Usage - Understand how credits are consumed by different features and tips for optimizing costs.
Getting Started - Learn how to authenticate API requests with your key.

Available Cities MCP Server