Loading...
Sign in to see the examples with your own API key.

Usage

The subscription's metered look-ups and limits. Requires your administration key — the API key you use for address look-ups cannot read usage, so you can hand that key to a front-end team without handing over your account's figures.

Only /get/{id} counts. Autocomplete is free and never appears here.

Request

GET https://api.getaddress.io/usage?api-key={your-admin-key}    
GET https://api.getaddress.io/usage/{day}/{month}/{year}?api-key={your-admin-key}    
GET https://api.getaddress.io/usage/from/{from-day}/{from-month}/{from-year}/to/{to-day}/{to-month}/{to-year}?api-key={your-admin-key}

Each route is also available under /v4/ — /v4/usage, /v4/usage/{day}/{month}/{year} and so on. The two spellings are the same endpoint.

Your daily limit and monthly extra

Your plan gives you a number of look-ups per UTC day. Most plans also carry a monthly extra allowance: when a busy day runs past its daily limit, look-ups keep being answered out of that pool rather than stopping, and only those overflow look-ups count against it.

So monthly_buffer_used is a figure for the whole calendar month, not for the day you asked about, and it reads the same on every day of that month. When it reaches monthly_buffer, look-ups still resume at midnight UTC — the daily allowance is what resets — but there is nothing left to borrow, so each remaining day that month stops at your daily limit.

A plan with no monthly extra reports 0 for both fields. A plan with no daily limit reports 2147483647.

Examples

Returns the usage and limits for a given day, month and year.

Request

GET https://api.getaddress.io/usage/28/9/2026?api-key={your-admin-key}

Response

{
    "date": "2026-09-28T00:00:00",
    "usage_today": 2000,
    "daily_limit": 2000,
    "monthly_buffer": 1000,
    "monthly_buffer_used": 150
}

A range returns one row per day, newest first. Days with no look-ups come back as zero rather than being left out, so you always get a row per day in the range. A range may not exceed 366 days.

Request

GET https://api.getaddress.io/usage/from/26/9/2026/to/28/9/2026?api-key={your-admin-key}

Response

[
    {
    "date": "2026-09-28T00:00:00",
    "usage_today": 89,
    "daily_limit": 2000,
    "monthly_buffer": 1000,
    "monthly_buffer_used": 150
    },
    {
    "date": "2026-09-27T00:00:00",
    "usage_today": 19,
    "daily_limit": 2000,
    "monthly_buffer": 1000,
    "monthly_buffer_used": 150
    },
    {
    "date": "2026-09-26T00:00:00",
    "usage_today": 29,
    "daily_limit": 2000,
    "monthly_buffer": 1000,
    "monthly_buffer_used": 150
    }
]
Top