---
title: "Get account usage"
method: GET
path: "/api/v1/usage"
---

# Get account usage

`GET /api/v1/usage`

## Request

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

Returns the authenticated account’s Insights aggregate. Full-scope and verify-scoped account keys are accepted. Counterparty keys are forbidden.

## Query parameters

- `period_days` integer

## Response `200`

Account usage aggregate

- Usage
  - `days` object[], required
    - `date` string, date, required
    - `runs` integer, required
    - `accepted` integer, required
    - `rejected` integer, required
    - `earned_micros` string, required: An exact integer number of millionths, encoded as a decimal string.
    - `fees_accrued_micros` string, required: An exact integer number of millionths, encoded as a decimal string.
  - `totals` object, required
    - `totalRuns` integer, required
    - `accepted` integer, required
    - `submitted` integer, required
    - `earned_micros` string, required: An exact integer number of millionths, encoded as a decimal string.
    - `fees_accrued_micros` string, required: An exact integer number of millionths, encoded as a decimal string.
    - `cogs_micros` string, required: An exact integer number of millionths, encoded as a decimal string.
    - `pass_rate` number, nullable, required
  - `use_cases` object[], required
    - `key` string, required
    - `label` string, required
    - `runs` integer, required
    - `accepted` integer, required
    - `delivered` integer, required
    - `earned_micros` string, required: An exact integer number of millionths, encoded as a decimal string.
    - `pass_rate` number, nullable, required
  - `recent` object[], required
  - `billing` object, required
    - `allowance` AllowanceState, required: Current calendar-month included usage: 10 verification runs and 10 free-text compiles.
      - `period_start` string, date, required
      - `period_end` string, date, required
      - `verification` object, required
        - `limit` integer, required
        - `used` integer, required
        - `remaining` integer, required
      - `compile` object, required
        - `limit` integer, required
        - `used` integer, required
        - `remaining` integer, required
    - `credits` object, required
      - `balance_micros` string, required: An exact integer number of millionths, encoded as a decimal string.

## Other responses

- `400`: Machine-readable API error
- `401`: Machine-readable API error
- `403`: Machine-readable API error
- `404`: Machine-readable API error
- `409`: Machine-readable API error
- `413`: Machine-readable API error
- `422`: Machine-readable API error
- `429`: Machine-readable API error
- `500`: Machine-readable API error
- `503`: Machine-readable API error

---

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