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 the account the API key belongs to.
Name
quotas
Type
object
Description
Contains information about your request quota. The month bucket reflects your regular monthly quota; the grace bucket is only relevant while a grace quota is active on your account.

Request

GET

/v1/status

curl -G "https://api.zipcodestack.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
        }
    }
}