# Usage: `GET /v1/usage`

Cost: free (0 (failed requests are free)). Docs: https://scrapercompany.com/docs/reference/usage

Request counts, errors, bytes, and latency for the calling key only.

Parameters:

- `period` (string; optional; default 30d; pattern ^(24h|7d|30d|90d)$): Aggregation window: 24 hours, 7, 30, or 90 days.

Response fields:

- `key` (object; required)
  - `key.name` (string; required)
  - `key.prefix` (string; required): First characters of the key, for display.
  - `key.rate_limit_per_min` (integer; required): This key's requests-per-minute limit.
  - `key.role` (string; required)
- `period` (object; required)
  - `period.name` (string; required; one of 24h, 7d, 30d, 90d)
  - `period.start` (string (date-time); required)
  - `period.end` (string (date-time); required)
- `totals` (object; required)
  - `totals.requests` (integer; required)
  - `totals.successful` (integer; required)
  - `totals.errors` (integer; required)
  - `totals.rate_limited` (integer; required)
  - `totals.response_bytes` (integer; required)
  - `totals.avg_duration_ms` (integer; required)
  - `totals.p95_duration_ms` (integer; required)
- `by_status` (array of object; required)
  - `by_status[].status` (integer; required)
  - `by_status[].requests` (integer; required)
- `by_endpoint` (array of object; required): Top 50 endpoints by request count.
  - `by_endpoint[].method` (string; required)
  - `by_endpoint[].path` (string; required)
  - `by_endpoint[].requests` (integer; required)
  - `by_endpoint[].errors` (integer; required)
  - `by_endpoint[].avg_duration_ms` (integer; required)
  - `by_endpoint[].p95_duration_ms` (integer; required)
- `by_day` (array of object; required)
  - `by_day[].date` (string (date); required)
  - `by_day[].requests` (integer; required)
  - `by_day[].errors` (integer; required)
  - `by_day[].response_bytes` (integer; required)

Base URL: `https://api.scrapercompany.com`. Auth: send your key in the `x-api-key` header. A failed request (4xx or 5xx) or an empty result costs 0 credits.

- [Full API reference as one Markdown file](https://scrapercompany.com/llms-full.txt)
- [OpenAPI spec](https://scrapercompany.com/openapi.json)
