Address Finder
Usage
Check how many Address Finder lookups your team has used and has left.
Check how many lookups your team has used and has left.
GET https://platform.scribeless.co/api/address-finder/usage
Headers
X-API-Key: YOUR_API_KEY
Example request
curl --request GET 'https://platform.scribeless.co/api/address-finder/usage' \
--header 'X-API-Key: YOUR_API_KEY'
Response
{
"used": 42,
"limit": 100,
"remaining": 58
}
Fields
| Field | Type | Description |
|---|---|---|
used | number | All lookups your team has made. |
limit | number or null | Your team's total lookup limit, or null when there is no limit. |
remaining | number or null | Lookups left, or null when there is no limit. |
The limit is a total. It does not reset each month. Contact the Scribeless team to add more lookups.
Status codes
| Status | Meaning |
|---|---|
200 | Usage returned. |
401 | Missing, malformed, invalid, or unauthorized API key. |
403 | Address Finder is not enabled for your team. |
502 | Address Finder is temporarily unavailable. Retry later. |