---
title: "This key's usage and limits"
method: GET
path: "/api/v1/usage"
tags: ["Platform"]
---

# This key's usage and limits

`GET /api/v1/usage`

## Request

- Base URL: `https://arbitron.app`
- URL: `https://arbitron.app/api/v1/usage`
- Auth: HTTP bearer

The plan behind the key, the month and minute windows, and what the plan includes (history depth, delay, commercial use).

## Response `200`

OK

- ApiEnvelopeOfUsageResponse
  - `data` UsageResponse, required
    - `plan` string, required
    - `key_prefix` string, required
    - `scopes` string[], required
    - `month` UsageWindow, required
      - `used` integer, required
      - `limit` integer, required
      - `remaining` integer, required
      - `resets_at` string, date-time, required
    - `minute` UsageWindow, required
      - `used` integer, required
      - `limit` integer, required
      - `remaining` integer, required
      - `resets_at` string, date-time, required
    - `history_days` integer, nullable, required
    - `delay_seconds` integer, required
    - `commercial_use` boolean, required
    - `upgrade_url` string, nullable, required
  - `meta` ApiMeta, required
    - `as_of` string, date-time, required
    - `delayed_seconds` integer, required
    - `source` string, required
    - `url` string, required
    - `count` integer, nullable
    - `total` integer, nullable
    - `next_cursor` string, nullable
    - `withheld` integer, nullable

---

[API](https://skmtc.dev/arbitron/apis/arbitron-api.md) · [All operations](https://skmtc.dev/arbitron/apis/arbitron-api/llms.txt) · [OpenAPI document](https://skmtc.dev/arbitron/apis/arbitron-api/revisions/dd08806fd48e?raw)