Docs
Log in

Account API

Programmatic access to your monthly usage stats: successes, failures, due amount, remaining credits, and per-domain breakdowns.

Overview

The Account API returns monthly usage statistics for your Crawlbase products. Use it to monitor consumption, build internal dashboards, or alert when you're approaching your credit limit.

This API is actively supported. It's grouped under "legacy" in the navigation only because it's an older endpoint shape - there's no replacement planned.

Endpoint:https://api.crawlbase.com/account

Rate limit: 1 request per 5 minutes

This endpoint aggregates a lot of data on the server side. Cache the response - there is no need to call it more frequently.

Quickstart

curl 'https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api'

Parameters

token
stringrequired
Your Crawlbase token.
product
stringrequired
Which product's usage to retrieve. One of: crawling-api, crawler, smartproxy, scraper-api, leads-api, screenshot-api.
previous_month
booleanfalse
When true, includes previous-month statistics alongside the current month for trend comparison.

Response fields

totalSuccess
Total successful requests this month.
totalFailed
Total failed requests this month.
totalDue
Total amount due in USD for successful requests this month.
remainingCredits
Credits still available this month. Only returned for subscription-based products.
domainStats
Array of per-domain breakdowns: domain, totalRequests, success, failure, successRate.

Per-product examples

# Crawling API
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api"

# Enterprise Crawler
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawler"

# Smart AI Proxy
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=smartproxy"

# Scraper API (legacy)
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=scraper-api"

# Leads API (legacy)
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=leads-api"

# Screenshots API (legacy)
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=screenshot-api"

# With previous month for trend comparison
curl "https://api.crawlbase.com/account?token=YOUR_TOKEN&product=crawling-api&previous_month=true"