Usage Statistics

Retrieve your account's usage statistics and remaining credits.

Endpoint

GET https://api.renderscreenshot.com/v1/usage

Authentication

Include your API key in the Authorization header:

Authorization: Bearer rs_live_xxxxx

Response

{
  "account": {
    "id": "acc_xxxxx",
    "plan": "pro",
    "billing_period": {
      "start": "2024-01-01T00:00:00Z",
      "end": "2024-02-01T00:00:00Z"
    }
  },
  "credits": {
    "total": 10000,
    "used": 4523,
    "remaining": 5477
  },
  "usage": {
    "screenshots": 4200,
    "batch_jobs": 45,
    "pdf_exports": 278,
    "storage_bytes": 1073741824
  },
  "rate_limits": {
    "requests_per_minute": 300,
    "concurrent_limit": 20,
    "batch_size_limit": 100
  },
  "current_period": {
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-02-01T00:00:00Z",
    "days_remaining": 15
  }
}

Response Fields

Account

Field	Type	Description
`account.id`	string	Your account identifier
`account.plan`	string	Current plan: `free`, `starter`, `pro`, `enterprise`
`account.billing_period`	object	Current billing period dates

Credits

Field	Type	Description
`credits.total`	integer	Total credits for billing period
`credits.used`	integer	Credits consumed this period
`credits.remaining`	integer	Available credits

Usage

Field	Type	Description
`usage.screenshots`	integer	Total screenshots captured
`usage.batch_jobs`	integer	Batch jobs executed
`usage.pdf_exports`	integer	PDF documents generated
`usage.storage_bytes`	integer	Cloud storage used (if enabled)

Rate Limits

Field	Type	Description
`rate_limits.requests_per_minute`	integer	Max requests per minute
`rate_limits.concurrent_limit`	integer	Max concurrent requests
`rate_limits.batch_size_limit`	integer	Max URLs per batch request

Example

curl https://api.renderscreenshot.com/v1/usage \
  -H "Authorization: Bearer rs_live_xxxxx"

Tracking Usage in Responses

Every screenshot response includes usage headers:

X-Credits-Used: 1
X-Credits-Remaining: 5476

Low Credits Warning

When credits are running low (<10%), the API returns a warning header:

X-Credits-Warning: low

Consider setting up webhook notifications for credit alerts in your dashboard.