Status Endpoint

The status endpoint returns information about your current quota.


GET/v2/status

Check API Status

This status endpoint returns information about your current quota and the plan of your account.

Response Properties

  • Name
    account_id
    Type
    integer
    Description

    The ID of the account the API key belongs to.

  • Name
    account_id_str
    Type
    string
    Description

    The same id as account_id, as a string for JavaScript clients, whose numbers lose precision above 2^53.

  • 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. Always present; all zero unless a grace quota is active.

  • Name
    plan
    Type
    object
    Description

    The plan of the account: name, interval, price_id, free, custom, status (of the subscription, e.g. active), renews_at, scheduled (a plan change that starts later, or null), upgrade_url (null for a custom plan) and plans_url (every plan as JSON). Use it to check that an upgrade took effect.

  • Name
    data
    Type
    object
    Description

    When each data layer behind the lookups was built (UTC), the dates of the X-Data-As-Of header of /v2/info and /v2/batch: geo, overrides, ipapi, security, domains and asn, each with as_of. A layer that is missing is left out. sources has the day of each source a build used, where it records them (asn: asn_networks, rir_delegations and bgp_routes). Also without an API key. registry is the build of the registry data behind company and abuse.

Request

GET
/v2/status
curl -G https://api.ipbase.com/v2/status \
    -H "apikey: YOUR-API-KEY"

Response

{
    "account_id": 313373133731337,
    "account_id_str": "313373133731337",
    "quotas": {
        "month": {
            "total": 150,
            "used": 72,
            "remaining": 78
        },
        "grace": {
            "total": 0,
            "used": 0,
            "remaining": 0
        }
    },
    "plan": {
        "name": "free",
        "interval": "month",
        "price_id": "price_1KopvdKszEJd98nkPnBdEH50",
        "free": true,
        "custom": false,
        "status": "active",
        "renews_at": "2026-11-01T00:00:00+00:00",
        "scheduled": null,
        "upgrade_url": "https://app.ipbase.com/upgrade?utm_source=agent&utm_campaign=status&team=313373133731337",
        "plans_url": "https://api.ipbase.com/v1/agent/plans"
    },
    "data": {
        "geo": { "as_of": "2026-10-12T03:41:09Z" },
        "overrides": { "as_of": "2026-10-17T03:20:44Z" },
        "ipapi": { "as_of": "2026-10-17T10:12:31Z" },
        "security": { "as_of": "2026-10-17T04:05:12Z" },
        "domains": { "as_of": "2026-10-16T06:48:02Z" },
        "asn": {
            "as_of": "2026-10-17T05:52:40Z",
            "sources": { "asn_networks": "2026-10-14", "rir_delegations": "2026-10-16", "bgp_routes": "2026-10-17" }
        }
    }
}