Docs/Account & Stats

Account & Stats

Retrieve your account details, credit balance, concurrency limits, and time-series usage data.

GET/api/v1/account

Get Account Info

Returns your current plan, credit balance, concurrency limit, request totals, and success rate.

Python

import requests

response = requests.get(
    "https://scrape.sparkproxy.io/api/v1/account",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
print(response.json())

Response

{
  "api_key":           "sk-xxxxxxxxxxxxxxxx",
  "email":             "[email protected]",
  "plan":              "pro",
  "credits_remaining": 4850,
  "total_credits":     5000,
  "total_used":        150,
  "api_concurrency":   3,
  "active_requests":   1,
  "requests_total":    312,
  "requests_success":  308,
  "requests_error":    4,
  "success_rate_pct":  98.7,
  "last_used_at":      "2026-06-27T12:34:56.000Z"
}

Field	Type	Description
`api_key`	string	Your API key.
`email`	string	Account email address.
`plan`	string	Current plan: free, starter, pro, or enterprise.
`credits_remaining`	number	Credits available to spend.
`total_credits`	number	Total credits purchased on current plan.
`total_used`	number	Cumulative credits consumed.
`api_concurrency`	number	Max simultaneous requests allowed.
`active_requests`	number	Requests currently in progress.
`requests_total`	number	Total requests made.
`requests_success`	number	Successful requests.
`requests_error`	number	Failed requests.
`success_rate_pct`	number	Success rate as a percentage (0–100).
`last_used_at`	ISO 8601	Timestamp of last API call.

GET/api/v1/stats

Get Usage Stats

Returns daily time-series data and a per-format breakdown for the past N days (default 30, max 90).

Query Param	Type	Default	Description
`days`	number	30	Number of past days to include (1–90).

Python

import requests

response = requests.get(
    "https://scrape.sparkproxy.io/api/v1/stats",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"days": 30},
)
data = response.json()
print(f"Requests last 30 days: {data['summary']['requests_total']}")
for row in data['daily']:
    print(row['date'], row['requests'], row['credits_used'])

Response

{
  "summary": {
    "api_key":          "sk-xxxxxxxxxxxxxxxx",
    "requests_total":   312,
    "requests_success": 308,
    "requests_error":   4,
    "success_rate_pct": 98.7,
    "total_used":       1560,
    "credits_remaining":4850,
    "total_credits":    5000
  },
  "by_format": [
    { "format": "html",       "requests": 200, "success": 198, "errors": 2 },
    { "format": "screenshot", "requests":  80, "success":  80, "errors": 0 },
    { "format": "md",         "requests":  32, "success":  30, "errors": 2 }
  ],
  "daily": [
    {
      "date":           "2026-06-27",
      "requests":       42,
      "success":        41,
      "errors":          1,
      "credits_used":   210,
      "avg_duration_ms":3840
    }
  ],
  "period_days": 30
}