freeiplookupapi.com Documentation

# Status Endpoint

Returns your current quota and the plan of your account.

Quota

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

Request Method: GET
Request URL: https://api.freeiplookupapi.com/v1/status

# Request Parameters

Parameter Type Mandatory Description
apikey string ️ Your API Key

# Sample Response

{
    "account_id": 313373133731337,
    "account_id_str": "313373133731337",
    "quotas": {
        "month": {
            "total": 5000,
            "used": 120,
            "remaining": 4880
        },
        "grace": {
            "total": 0,
            "used": 0,
            "remaining": 0
        }
    }
}

account_id identifies your account, account_id_str is the same id as a string for JavaScript clients, whose numbers lose precision above 2^53. quotas.month is your monthly plan quota. quotas.grace is a temporary grace quota your account may be granted so your integration keeps working after the monthly quota is exhausted (for example while a subscription payment is still being completed) — while it is active, requests are counted against it instead of the monthly quota. All grace values are 0 when no grace period is active.

The response also has a plan object after quotas: 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 and plans_url (every plan as JSON).

← Info Endpoint →