Skip to main content
GET
/
smartbrowse
/
usage
Current SmartBrowse plan caps and 30-day usage
curl --request GET \
  --url https://api.webscrape.ai/v1/smartbrowse/usage \
  --header 'X-API-Key: <api-key>'
{
  "status": "completed",
  "request_id": "req_aB3xY9Kp",
  "data": {
    "runs_used_30d": 123,
    "runs_per_month_cap": 123,
    "pages_per_run_cap": 123,
    "cost_per_page": 123,
    "schedules_count": 123,
    "schedules_allowed": true,
    "last_run": {
      "id": "k7Xb9dRmQ2p",
      "pages_extracted": 123,
      "effective_cap": 123,
      "clamped_by_credits": true,
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  },
  "credits_used": 0,
  "credits_remaining": 123
}

Authorizations

​
X-API-Key
string
header
required

Generate from the dashboard. Format: wsg_live_<32 base62 chars>.

Response

Usage returned.

​
status
enum<string>
required

Discriminator for the envelope variant.

Available options:
completed
​
request_id
string
required

Per-request id. Also returned as the X-Request-ID response header. Include it when reporting issues.

Example:

"req_aB3xY9Kp"

​
data
object
required
​
credits_used
integer
required

Always 0 — polling usage is free.

Example:

0

​
credits_remaining
integer
required