Account & usage

Balance, concurrency and daily usage for the key's account.

Embed

<a href="https://scrapelyserp.com/reference/account"><img src="https://scrapelyserp.com/reference/_api/public/orgs/affc5b0f-d3c2-423a-8143-9d10db5736ae/spaces/e4cbe065-c1c2-4572-b134-0292dedd9c39/pages/e77417ad-1f4f-4bac-a1ca-1a709d6828cc/social-card.svg?v=3e7ae33eec8b" alt="Account &amp; usage" width="600" height="315"></a>

Balance, concurrency and daily usage for the key's account.

Endpoints

Method	Path	Does
`GET`	`/v1/account`	Get account
`GET`	`/v1/usage`	Get usage

How it works, when to use what, and what it costs: Tiers & credits. Base URL, authentication and errors: Overview.

GET /v1/account

Get account.

Credit balance, lifetime credits, concurrency limit (with the calls in flight now and the next tier), auto top-up, and which key made the call. Free.

Request

cURL
Python
Node.js

curl "https://api.scrapelyserp.com/v1/account" \
  -H "Authorization: Bearer $SCRAPELY_API_KEY"

import os
import requests

HEADERS = {"Authorization": f"Bearer {os.environ['SCRAPELY_API_KEY']}"}

r = requests.get(
    "https://api.scrapelyserp.com/v1/account",
    headers=HEADERS,
    timeout=30,
)
r.raise_for_status()
data = r.json()

const res = await fetch('https://api.scrapelyserp.com/v1/account', {
  headers: { Authorization: `Bearer ${process.env.SCRAPELY_API_KEY}` },
  signal: AbortSignal.timeout(30_000),
});
if (!res.ok) throw new Error((await res.json()).error.code);
const data = await res.json();

Response

200 OK
401 Unauthorized

{
  "object": "account",
  "id": "acct_4d5e6f7a8b9c0d1e",
  "name": "Acme Retail",
  "email": "dev@example.com",
  "credit_balance": 412640,
  "lifetime_credits": 605000,
  "credits_spent": 192360,
  "concurrency": {
    "limit": 50,
    "in_flight": 3,
    "next_tier": {
      "concurrency": 100,
      "at_lifetime_credits": 2000000
    }
  },
  "auto_topup": {
    "enabled": true,
    "threshold_credits": 50000,
    "pack_id": "growth"
  },
  "webhook_endpoints": 1,
  "api_key": {
    "id": "key_9a8b7c6d5e4f",
    "name": "Production",
    "prefix": "sk_live_3f9a"
  },
  "created_at": "2026-09-01T12:00:00.000Z"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or revoked API key.",
    "param": "api_key",
    "docs": "/docs/errors#unauthorized"
  }
}

Responses

Status	Meaning
`200`	The account the key belongs to.
`401`	`UNAUTHORIZED`: missing, unknown or revoked key.
`429`	`RATE_LIMITED` or `CONCURRENCY_LIMIT`. Honour `Retry-After`.
`500`	`INTERNAL`: our fault, not charged. Quote `X-Request-Id`.

Response fields

Field	Type	Description
`object`	"account"	—
`id`	string	—
`name`	string	—
`email`	string	—
`credit_balance`	integer	Prepaid credits remaining. They never expire.
`lifetime_credits`	integer	Credits ever purchased, plus the signup grant. Sets your concurrency tier.
`credits_spent`	integer	—
`concurrency`	object	—
`concurrency.limit`	integer	—
`concurrency.in_flight`	integer	—
`concurrency.next_tier`	object or null	—
`auto_topup`	object or null	—
`auto_topup.enabled`	boolean	—
`auto_topup.threshold_credits`	integer	—
`auto_topup.pack_id`	string	—
`webhook_endpoints`	integer	Registered webhook endpoints (`GET /v1/webhook_endpoints` lists them).
`api_key`	object	—
`api_key.id`	string	—
`api_key.name`	string	—
`api_key.prefix`	string	—
`created_at`	string (date-time)	—

GET /v1/usage

Get usage.

Requests, successes, failures and credits per day for the last days days, oldest first, with totals for the window. Free.

Query parameters

Name	Type	Required	Description
`days`	integer	—	How many days to report. Default `30`. From 1 to 90.

Request

cURL
Python
Node.js

curl -G "https://api.scrapelyserp.com/v1/usage" \
  -H "Authorization: Bearer $SCRAPELY_API_KEY" \
  -d days=3

import os
import requests

HEADERS = {"Authorization": f"Bearer {os.environ['SCRAPELY_API_KEY']}"}

r = requests.get(
    "https://api.scrapelyserp.com/v1/usage",
    headers=HEADERS,
    params={"days": "3"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

const res = await fetch(`https://api.scrapelyserp.com/v1/usage?${new URLSearchParams({ days: '3' })}`, {
  headers: { Authorization: `Bearer ${process.env.SCRAPELY_API_KEY}` },
  signal: AbortSignal.timeout(30_000),
});
if (!res.ok) throw new Error((await res.json()).error.code);
const data = await res.json();

Response

200 OK
401 Unauthorized

{
  "object": "usage",
  "days": 3,
  "totals": {
    "requests": 1294,
    "successful": 1288,
    "failed": 6,
    "credits": 58210,
    "success_rate": 0.9954
  },
  "daily": [
    {
      "date": "2026-10-14",
      "requests": 431,
      "successful": 430,
      "failed": 1,
      "credits": 19402
    },
    {
      "date": "2026-10-15",
      "requests": 442,
      "successful": 439,
      "failed": 3,
      "credits": 19918
    },
    {
      "date": "2026-10-16",
      "requests": 421,
      "successful": 419,
      "failed": 2,
      "credits": 18890
    }
  ]
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or revoked API key.",
    "param": "api_key",
    "docs": "/docs/errors#unauthorized"
  }
}

Responses

Status	Meaning
`200`	Daily requests and credits, oldest first.
`401`	`UNAUTHORIZED`: missing, unknown or revoked key.
`429`	`RATE_LIMITED` or `CONCURRENCY_LIMIT`. Honour `Retry-After`.
`500`	`INTERNAL`: our fault, not charged. Quote `X-Request-Id`.

Response fields

Field	Type	Description
`object`	"usage"	—
`days`	integer	—
`totals`	object	—
`totals.requests`	integer	—
`totals.successful`	integer	—
`totals.failed`	integer	—
`totals.credits`	integer	—
`totals.success_rate`	number or null	—
`daily`	object[]	—
`daily[].date`	string	—
`daily[].requests`	integer	—
`daily[].successful`	integer	—
`daily[].failed`	integer	—
`daily[].credits`	integer	—

Updated Oct 19, 2026

Was this page helpful?