Skip to content

Quota Usage

Retrieve your current quota usage for the billing period. This endpoint allows you to monitor how many API verifications you've consumed and how many remain in your monthly allocation.

Requires authentication using an API key.

Request

GET https://api.siachecker.co.uk/v1/quota/usage

Successful response

200 OK

JSON
{
  "period": "2025-12",
  "used": 42,
  "quota": 100,
  "remaining": 58
}

Response fields

Field Type Description
period string Current billing period in YYYY-MM format
used number Number of verifications used in the current period
quota number or null Monthly quota limit (null for unlimited tier)
remaining number or null Remaining quota for this period (null for unlimited tier)

Errors

401 Unauthorized

Returned when the API key is invalid, missing, or expired.

JSON
{
  "code": "UNAUTHORIZED",
  "message": "Invalid or missing API key"
}

500 Internal Server Error

Returned when an unexpected error occurs on the server.

JSON
{
  "code": "INTERNAL_ERROR",
  "message": "An internal error occurred while processing the request."
}

Notes

  • Billing periods reset on the first day of each month
  • Quota usage is tracked per user based on their API key
  • Unlimited tiers will show null for quota and remaining fields