---
title: "Retrieve your usage · API docs · CheckAnySite"
description: "Returns the credits your account has used and has left this month (UTC), the key’s own limit if it has one, and the price of each check."
url: "https://docs.checkanysite.com/api/get-usage"
---

API reference

# Retrieve your usage

GET `/v1/usage`

Returns the credits your account has used and has left this month (UTC), the key’s own limit if it has one, and the price of each check.

Credits

Free.

## Request

```bash cURL
curl "https://api.checkanysite.com/v1/usage" \
  -H "Authorization: Bearer $CHECKANYSITE_API_KEY"
```

```python
from checkanysite import CheckAnySite

client = CheckAnySite()  # Reads the key from CHECKANYSITE_API_KEY.

usage = client.usage.retrieve()
```

```javascript
const url = 'https://api.checkanysite.com/v1/usage';
const response = await fetch(url, {
  headers: {
    Authorization: `Bearer ${process.env.CHECKANYSITE_API_KEY}`,
  },
});
const usage = await response.json();
```

## Response

| Status | Body | When |
| --- | --- | --- |
| 200 OK | `Usage` | This month’s credits. |

```json Response 200: This month’s credits
{
  "period": {
    "start": "2026-11-01T00:00:00.000Z",
    "end": "2026-12-01T00:00:00.000Z"
  },
  "allowance": 300,
  "used": 108,
  "remaining": 192,
  "key": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "name": "Production",
    "monthlyCreditLimit": 120,
    "used": 36,
    "remaining": 84
  },
  "prices": {
    "checks": {
      "ai": {
        "stored": 1,
        "scan": 3
      },
      "readiness": {
        "stored": 1,
        "scan": 4
      },
      "popularity": {
        "stored": 1,
        "scan": 1
      },
      "tech": {
        "stored": 1,
        "scan": 3
      },
      "dns": {
        "stored": 1,
        "scan": 1
      },
      "trust": {
        "stored": 2,
        "scan": 6
      },
      "summary": {
        "stored": 2,
        "scan": 5
      },
      "history": {
        "stored": 1,
        "scan": 2
      }
    },
    "allChecks": {
      "stored": 3,
      "scan": 15
    }
  },
  "rateLimit": {
    "requests": 60,
    "periodSeconds": 60
  }
}
```

- `period` object

  The calendar month (UTC) the credits count in.
- `period.start` date-time

  When the month began.
- `period.end` date-time

  When it ends and the credits start again.
- `allowance` integer

  The account’s credits this month.
- `used` integer

  The credits the account used this month, all keys together.
- `remaining` integer

  The account’s credits left this month.
- `key` object

  The key that made this call.
- `key.id` string

  The key’s id.
- `key.name` string

  The name you gave it.
- `key.monthlyCreditLimit` integer or null

  Its own monthly limit; null when it has none.
- `key.used` integer

  The credits it used this month.
- `key.remaining` integer or null

  What its own limit leaves; null without one.
- `prices` object

  What a call costs, in credits: each check it asks, never more than every check at once.
- `prices.checks` object

  What each check costs.
- `prices.allChecks` object

  The most a call costs: every check at once, asked when `checks` is left out.
- `rateLimit` object

  How fast a key may call.
- `rateLimit.requests` integer

  Calls a key may make in a period.
- `rateLimit.periodSeconds` integer

  The period, in seconds.

## Errors

| Status | Code | What happened |
| --- | --- | --- |
| 401 | [missing\_api\_key](https://docs.checkanysite.com/errors#missing_api_key) | No API key |
| 401 | [invalid\_api\_key](https://docs.checkanysite.com/errors#invalid_api_key) | Unknown API key |
| 401 | [revoked\_api\_key](https://docs.checkanysite.com/errors#revoked_api_key) | Revoked API key |
| 401 | [expired\_api\_key](https://docs.checkanysite.com/errors#expired_api_key) | Expired API key |
| 429 | [rate\_limited](https://docs.checkanysite.com/errors#rate_limited) | Too many requests |
| 500 | [internal\_error](https://docs.checkanysite.com/errors#internal_error) | Internal error |