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/v2/status

Check API Status

This status endpoint returns information about your current quota.

Required attributes

Name
apikey
Type
string
Description
Your API Key - you can retrieve your API key from your ipbase dashboard.

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. Holds a month object with your regular monthly quota and a grace object with your grace quota (used e.g. while a payment is being completed).
Name
quotas.month
Type
object
Description
Your monthly quota: total (requests included in your plan), used (requests consumed this month) and remaining (requests left this month).
Name
quotas.grace
Type
object
Description
Your grace quota with the same total / used / remaining fields. All zero unless a grace quota is active.

When called without an API key, the endpoint responds with an hourly quota shape instead: {"quotas": {"hour": {"total": 10}}}.

Request

GET

/v2/status

curl -G https://api.ipbase.com/v2/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
        }
    }
}