---
title: "Check credit balance and limits"
method: GET
path: "/usage"
---

# Check credit balance and limits

`GET /usage`

## Request

- Base URL: `https://indexed.vc/api/v1`
- URL: `https://indexed.vc/api/v1/usage`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/indexed/apis/indexed-vc-api/docs/usage/get.ts> (a function with typed inputs; its response is checked against the schema)

FREE — does not consume credits. Returns tier, credit balance, and rate limits.

## Response `200`

Usage data

- object
  - `data` UsageData
    - `credits_included` integer
    - `credits_used` integer
    - `credits_remaining` integer
    - `pack_credits_remaining` integer
    - `low_balance_threshold` number: Alert threshold for the active subscription or latest-pack bucket
    - `low_balance_basis` integer: Current bucket size used to derive the 10% threshold
    - `overage_enabled` boolean
    - `overage_credits_used` integer
    - `period_start` string, date-time, nullable
    - `period_end` string, date-time, nullable
    - `tier` 'free' | 'silver' | 'gold' | 'platinum' | 'enterprise'
    - `limits` object
      - `rate_limit_per_minute` integer
      - `api_keys_max` integer
      - `reveal_batch_size_max` integer
      - `reveal_hourly_max` integer

## Other responses

- `401`: Missing, invalid, or insufficient API key

---

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