Skip to main content
Use GET /usage for Residential, Datacenter, Mobile, and ISP credentials. Static ISP and Static Datacenter subscriptions are excluded. Your API key selects the workspace; omit organization IDs.

​
Read usage

Without a selector, totals cover all current credentials, including disabled and unused ones. Deleted credentials are excluded; passwords are never returned. Add username=resi_jobs or credential_id=<id> from the response to select one credential. Use the base username without country, city, or session suffixes. Never combine selectors. Unknown credentials and credentials outside your workspace return 404.

​
Dates and units

  • Supply both dates in YYYY-MM-DD format, or omit both for the current UTC calendar month.
  • from is inclusive; to is exclusive and must follow from. Use May 1 to include all of April.
  • Each range can cover at most 366 days. Split longer reports into adjacent ranges.
  • bandwidth_bytes uses bytes: 1 GB = 1,000,000,000 bytes. requests counts proxy requests. wallet_spent_cents uses integer USD cents.

​
Wallet usage charges

wallet_spent_cents counts actual usage debits, dated by usage window start. Older debits without a usage window use their posting date. Package-funded traffic adds bandwidth and requests without a wallet debit. wallet_spent_cents excludes package purchases, static subscription fees, top-ups, adjustments, and positive ledger entries. It is not an invoice total or wallet balance; use GET /balance for your balance.
Recent traffic and charges may appear separately and take time to settle. Read limits default to 120 requests per minute per key. On 429, follow Retry-After.
See the usage reference for response fields and an interactive request.