api reference

Usage and health

GET /v1/usage returns your own quota and usage; GET /v1/health reports API status; /openapi.json is the machine-readable spec.

View as Markdown

GET /v1/usage

GET https://api.isbusinessemail.com/v1/usage

Returns usage for the account that owns the key. Secret keys only. Reading usage doesn’t count as a check.

curl -s https://api.isbusinessemail.com/v1/usage \
  -H "Authorization: Bearer $IBE_API_KEY"

The response includes:

  • your tier and its limits (per second, per day, requests in flight)
  • checks used today and remaining, and when the quota resets (00:00 UTC)
  • today’s checks broken down by category
  • the deep checks used today

The exact field names are in /openapi.json and the API reference. For history (30-day charts, latency percentiles, your last 1,000 requests by domain), use the dashboard.

You often don’t need this endpoint: every /v1/check response already carries X-RateLimit-Remaining and the RateLimit header. See Rate limits.

Example: alert before you run out

import os
import requests

r = requests.get(
    "https://api.isbusinessemail.com/v1/usage",
    headers={"Authorization": f"Bearer {os.environ['IBE_API_KEY']}"},
    timeout=3,
)
r.raise_for_status()
print(r.json())  # feed the remaining-checks value into your monitoring

GET /v1/health

GET https://api.isbusinessemail.com/v1/health

A cheap liveness check for your monitoring. No key needed, not counted. A 200 means the API is up. During partial outages checks keep working from our lists; individual check responses then carry degraded: true.

Status history and incidents: status.isbusinessemail.com.

GET /openapi.json

GET https://api.isbusinessemail.com/openapi.json

The OpenAPI 3.1 description of the public API, generated from the same schemas that validate requests and responses. Use it to generate a client, import into Postman or Insomnia, or browse it in the API reference.