Retrieve your usage

Request

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

from checkanysite import CheckAnySite

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

usage = client.usage.retrieve()

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

{
  "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
  }
}

• periodobject

  The calendar month (UTC) the credits count in.

• period.startdate-time

  When the month began.

• period.enddate-time

  When it ends and the credits start again.

• allowanceinteger

  The account’s credits this month.

• usedinteger

  The credits the account used this month, all keys together.

• remaininginteger

  The account’s credits left this month.

• keyobject

  The key that made this call.

• key.idstring

  The key’s id.

• key.namestring

  The name you gave it.

• key.monthlyCreditLimitinteger or null

  Its own monthly limit; null when it has none.

• key.usedinteger

  The credits it used this month.

• key.remaininginteger or null

  What its own limit leaves; null without one.

• pricesobject

  What a call costs, in credits: each check it asks, never more than every check at once.

• prices.checksobject

  What each check costs.

• prices.allChecksobject

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

• rateLimitobject

  How fast a key may call.

• rateLimit.requestsinteger

  Calls a key may make in a period.

• rateLimit.periodSecondsinteger

  The period, in seconds.

Errors