---
title: "This key's plan, monthly quota, calls used and reset date"
method: GET
path: "/api/v1/usage"
---

# This key's plan, monthly quota, calls used and reset date

`GET /api/v1/usage`

## Request

- Base URL: `https://bidprowl.com`
- URL: `https://bidprowl.com/api/v1/usage`
- Auth: HTTP bearer

Does not count against the quota. The same numbers ride on every response as RateLimit-* headers.

## Response `200`

Usage

- object
  - `data` Usage
    - `key_id` string
    - `plan` 'free' | 'pro' | 'pro_plus'
    - `period` string: Quota month, YYYY-MM (UTC)
    - `limit` integer
    - `used` integer
    - `remaining` integer
    - `resets_at` string, date-time: First of next month, 00:00 UTC
    - `resets_at_epoch` integer
    - `batch_comps_max` integer: Max queries per POST /api/v1/comps/batch
    - `features` object
      - `item_comps` boolean
      - `sold_history_item_level` boolean
      - `csv_export` boolean
      - `webhooks` boolean

## Other responses

- `401`: Missing, invalid or revoked API key.
- `429`: Per-minute burst limit or monthly quota exhausted. Read Retry-After, and RateLimit-* to self-throttle before you get here.

---

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