IPRout

GET /usage Request Guide

GET https://api.iprout.com/usage returns the authenticated account's current month, total requests, monthly limit, remaining requests, and an api_keys array with usage for each key. Use it for dashboards and alerts; the usage request itself does not consume the lookup allowance.

Last updated September 12, 2026

How do I request usage?

Authenticate the same way as a lookup request.

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.iprout.com/usage

What does the summary contain?

The response includes month, total_requests, monthly_limit, remaining_requests, and per-key records with requests_this_month, remaining_requests, plan, monthly_limit, and last_used_at.

How can I use this data?

Display capacity, alert on low remaining quota, and identify which named integration is consuming requests.

  • Poll at a modest interval
  • Do not publish usage data or key identifiers
  • Treat last_used_at as nullable for unused keys

How should retrieving usage data be implemented?

Call GET /usage from an authenticated operations boundary and parse it with a model separate from IpInfo. Cache the result briefly instead of requesting it before every lookup. Keep this responsibility close to the IPRout client so the behavior documented in GET /usage Request Guide remains consistent across web requests, workers, and scheduled jobs.

How should retrieving usage data be verified?

Check month, total_requests, monthly_limit, remaining_requests, and api_keys with active and unused-key fixtures. Allow last_used_at to be null and preserve numeric count types. Automate the stable cases and reserve live checks for controlled environments so verification is repeatable without consuming unnecessary production allowance.

How should retrieving usage data be operated?

Display the observation time beside dashboards and compare shared capacity with each key's own remaining value. Protect the response because identifiers and consumption patterns expose account operations. Write down the owner and expected behavior so an alert or product change can be handled without reconstructing the original integration decisions.

Where does retrieving usage data stop?

The endpoint reports the current usage view; it is not a billing ledger or a guarantee of capacity reserved for future traffic. Concurrent requests can change values immediately after retrieval. Treat that limit as part of the feature contract and direct callers to the related guide when they need a different guarantee or control.

What belongs in the release review for retrieving usage data?

Review the deployed implementation of GET /usage Request Guide, not only a local sample. Confirm the intended endpoint, credential source, timeout, response model, and fallback from the environment that will carry real traffic. Use the verification cases above as release evidence, inspect generated browser assets and logs for secret exposure, and make sure dashboards identify the workload without storing raw credentials or unnecessary IP data. Record the configuration owner and rollback action before enabling the feature broadly.

When should retrieving usage data be revisited?

Revisit retrieving usage data when traffic volume, plan capacity, application ownership, deployment regions, browser origins, data retention, or the product consequence of a lookup changes. Compare the current implementation with the documented operating boundary rather than assuming the original decision still fits. Update tests and internal runbooks together, then verify the public API contract and related IPRout guides before rolling the change across every service that shares the client or account.

External references

Continue with the standards and official documentation most relevant to this guide.

Continue building with IPRout

Test the API, browse runnable examples, or return to the documentation directory.