---
title: "Get credit balance and usage for the calling key"
method: GET
path: "/v1/usage"
tags: ["Account"]
---

# Get credit balance and usage for the calling key

`GET /v1/usage`

## Request

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

Free operation. Returns the balance, today's free-allowance state, and per-route consumption for the requested window. Call this before a paid parse to avoid a 402.

## Query parameters

- `days` integer

## Response `200`

Usage summary for the authenticated key

- object
  - `key` object, required
    - `prefix` string, required
    - `plan` string, required
  - `credits` object, nullable: Null when the key has no credit balance row.
    - `balance` integer
    - `updated_at` string, nullable
  - `free_daily` object, nullable: Null for paid and dev keys, which are not daily-limited.
    - `limit` integer
    - `used` integer
    - `remaining` integer
  - `today` object, required
    - `day` string, date
    - `parses` integer
  - `window` object, required
    - `days` integer
    - `since` string, date
    - `calls` integer
    - `credits_spent` integer
    - `by_route` object[]
      - `route` string
      - `calls` integer
      - `credits` integer
    - `by_day` object[]
      - `day` string, date
      - `parses` integer

## Other responses

- `401`: Request failed
- `503`: Request failed

---

[API](https://skmtc.dev/tabularrecipe/apis/tabular-recipe-api.md) · [All operations](https://skmtc.dev/tabularrecipe/apis/tabular-recipe-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tabularrecipe/apis/tabular-recipe-api/revisions/273485a7c044?raw)
