Usage
ActiveGET/v1/usageFree
Back to library
Usage API
Retrieve real-time usage statistics and credit balance for your BrowserSolver account.
Mode overview
Docs, credit weight, and runnable examples for this endpoint.
OverviewLink to Overview
The Usage endpoint returns a complete snapshot of your BrowserSolver account's credit consumption, subscription status, rate limits, and API key metadata. Use it to monitor your usage programmatically and trigger alerts or top-ups before running out of credits.
QuickstartLink to Quickstart
GET https://api.BrowserSolver.com/v1/usage
ParametersLink to Parameters
This endpoint requires no query parameters. Authentication is performed via the x-api-key header.
| Parameter | Type | Required | Description |
|---|---|---|---|
x-api-key |
string | yes | Your private BrowserSolver API key |
Response fieldsLink to Response fields
| Field | Type | Description |
|---|---|---|
remaining |
number | Total remaining credits on the account |
total_used |
number | Total credits consumed since account creation |
renewal_date |
string | null | Date of the next subscription renewal (ISO 8601) |
period.start |
string | Start date of the current billing period |
period.end |
string | End date of the current billing period |
subscription.used |
number | Credits used from the subscription in the current period |
subscription.total |
number | Total subscription credits allocated per period |
subscription.remaining |
number | Remaining subscription credits in the current period |
subscription.percent_used |
number | Percentage of subscription credits consumed |
credits.given |
number | Bonus credits given to the account |
credits.consumed |
number | Bonus credits consumed |
credits.remaining |
number | Remaining bonus credits |
credits.percent_used |
number | Percentage of bonus credits consumed |
rate_limit.per_minute |
number | null | Maximum API calls allowed per minute (null = unlimited) |
rate_limit.per_second |
number | null | Maximum API calls allowed per second (null = unlimited) |
account.name |
string | Name of the BrowserSolver account |
account.slug |
string | Slug identifier for the account |
api_key.alias |
string | Human-readable alias of the API key used |
api_key.active |
boolean | Whether the API key is currently active |
api_key.category |
string | Category of the API key (e.g. development, production) |
api_key.expires |
string | null | Expiry date of the API key, or null if it never expires |
api_key.quotas.total |
number | null | Total request quota for the key (null = unlimited) |
api_key.quotas.daily |
number | null | Daily request quota (null = unlimited) |
api_key.quotas.weekly |
number | null | Weekly request quota (null = unlimited) |
api_key.quotas.monthly |
number | null | Monthly request quota (null = unlimited) |
NotesLink to Notes
- This endpoint requires a valid
x-api-keyheader. Requests without a key will return401 Unauthorized. percent_usedvalues may exceed 100 if top-ups or overage scenarios apply.rate_limitvalues arenullfor plans without rate limiting.
Main use casesLink to Main use cases
- Monitor remaining credits in real time and trigger automated top-up workflows before exhausting your quota
- Build internal dashboards that display API consumption per team or project
- Set up alerting systems that notify your team when usage exceeds a defined threshold
- Validate API key status and expiry before running batch scraping jobs
Scrape your first blocked URL
Fetch, render, screenshot, or unlock from one dashboard. Proxies, browsers, and anti-bot lanes stay on our side.
- 500 signup credits
- No card to start
- All scraping modes