Account

Account API

Your plan, allowance and what is left of it.

Get your limits

GET/v1/user/limits

API key

Response fields

accountTypestring
Plan name, such as Free or Pro.
limitinteger
Requests allowed this month.
usageinteger
Requests used this month.
remaininginteger
Requests left this month.
resetDatestring
Date the monthly allowance resets.
daily.limitinteger
Requests allowed today, on plans with a daily cap.
daily.usedinteger
Requests used today.
daily.remaininginteger
Requests left today.
daily.resetAtstring
When the daily window resets.
hourly.limitinteger
Requests allowed this hour.
hourly.usedinteger
Requests used this hour.
hourly.remaininginteger
Requests left this hour.
hourly.resetAtstring
When the hourly window resets.

curl https://ipscanner.io/v1/user/limits \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "accountType": "Free",
  "limit": 30000,
  "usage": 4180,
  "remaining": 25820,
  "resetDate": "2026-11-01",
  "daily": {
    "limit": 1000,
    "used": 212,
    "remaining": 788,
    "resetAt": "2026-10-07T00:00:00Z"
  },
  "hourly": {
    "limit": 100,
    "used": 14,
    "remaining": 86,
    "resetAt": "2026-10-06T15:00:00Z"
  }
}

Get your usage

GET/v1/usage/summary

API key

Response fields

planstring
Plan name.
usedinteger
Requests used this month.
limitinteger
Requests allowed this month.
remaininginteger
Requests left this month.
percentnumber
Share of the monthly allowance used.
unlimitedboolean
True on plans without a monthly cap.
softBlockedboolean
True when the account is over a limit.
blockedBystring
Which limit is blocking you: monthly, daily, hourly or empty.
bulkCapinteger
Most addresses one bulk call may hold on your plan.
periodStartstring
First day of the billing month.
resetDatestring
Date the monthly allowance resets.

curl https://ipscanner.io/v1/usage/summary \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "plan": "Free",
  "used": 4180,
  "limit": 30000,
  "unlimited": false,
  "remaining": 25820,
  "percent": 13.9,
  "softBlocked": false,
  "blockedBy": "",
  "upgradeHint": false,
  "bulkCap": 100,
  "daily": {
    "limit": 1000,
    "used": 212,
    "remaining": 788,
    "resetAt": "2026-10-07T00:00:00Z"
  },
  "hourly": {
    "limit": 100,
    "used": 14,
    "remaining": 86,
    "resetAt": "2026-10-06T15:00:00Z"
  },
  "periodStart": "2026-10-01",
  "resetDate": "2026-11-01",
  "asOf": "2026-10-06T14:05:00Z"
}