---
title: "Get your usage and allowance"
method: GET
path: "/usage"
tags: ["Account"]
---

# Get your usage and allowance

`GET /usage`

## Request

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

The same numbers the API uses to accept or refuse a search. Free: costs no request, but counts toward the per-minute rate limit.

## Response `200`

Your usage.

- Usage
  - `plan` string, required: Your plan, like free or pro.
  - `used` integer, required: Requests counted against the allowance: in the rolling 30 days, or of the one-time free credit when window is one_time. Free accounts include linked accounts.
  - `limit` integer, nullable, required: The plan's allowance per rolling 30 days, or the size of the one-time free credit when window is one_time. Null when unlimited.
  - `remaining` integer, nullable, required: limit minus used, never below 0. Null when unlimited.
  - `extra_requests` integer, required: Extra requests bought on top of the plan. Spent only after the allowance.
  - `window` 'rolling_30_days' | 'one_time', required: rolling_30_days: usage frees up as it ages out. one_time: a free account's one-time credit, which does not refill.
  - `shared_allowance` boolean, required: True when other linked free accounts draw on the same allowance.
  - `rate_limit_per_minute` integer, required: API calls allowed per minute, job polls and this call included.

## Other responses

- `401`: invalid_api_key: The API key is missing, malformed or revoked.
- `403`: account_suspended: The account is suspended, so none of its keys work. Email support to restore it. origin_not_allowed: A browser sent the request from a site that isn't allowed. Call the API from your server.
- `405`: method_not_allowed: Wrong method for this route. Searches, jobs and usage use GET. Only /v1/batches takes POST.
- `429`: rate_limited: More than 60 API calls this minute for your account.
- `503`: storage_unavailable: Our database is briefly unavailable. origin_unavailable: The edge couldn't reach our API server. service_unconfigured: The API is misconfigured on our side. Contact support.

---

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