Status Endpoint

The status endpoint returns information about your current quota.

Requests to this endpoint do not count against your quota or rate limit.

GET/v1/status

Check API Status

This status endpoint returns information about your current quota.

Response Properties

Name
account_id
Type
integer
Description
The id of your numlookupapi account (team).
Name
quotas
Type
object
Description
Contains information about your request quota, split into a month and a grace bucket.
Name
quotas.month
Type
object
Description
Your monthly request quota: total (the quota included in your plan), used (requests consumed this month) and remaining (requests left this month, always total - used).
Name
quotas.grace
Type
object
Description
Your grace quota with the same total, used and remaining fields. The grace quota is a temporary allowance we grant while there is an issue with your subscription payment, so your integration keeps working until the payment is completed. While a grace quota is active, requests count against it instead of your monthly quota. If no grace period is active, all values are 0.

Request

GET

/v1/status

curl -G https://api.numlookupapi.com/v1/status \
    -H "apikey: YOUR-API-KEY"

Response

{
    "account_id": 313373133731337,
    "quotas": {
        "month": {
            "total": 300,
            "used": 72,
            "remaining": 228
        },
        "grace": {
            "total": 0,
            "used": 0,
            "remaining": 0
        }
    }
}