v50

latestOpenAPI 3.0.3AGPLv3raw.githubusercontent.com2026-04-1028178439.6 KB
Keys

Logs (CSV)

Reports lookup information on a key for paid lookups.

This method requires a user_token, which can be found on your accounts page.

A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval.

Download Usage History (CSV)

GET /keys/:key/lookups

Returns a CSV download of lookups performed and associated information.

Note that the Content-Type returned will be CSV (text/csv). For a non 200 response, the Content-Type will revert to JSON with the error code and message embedded.

Data Redaction

Personally Identifiable Data (PII) caught in this your usage log (including IP, search term and URL data) will be redacted on a weekly basis.

By default, PII will be redacted if it is older than 21 days. This timeframe can be configured from your dashboard.

You may prevent PII collection altogether by setting the interval to 0 days.

get/keys/{key}/lookups

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

Query parameters

user_tokenstring

Private User Token

A secret key used for sensitive operations on your account and API Keys.

Your user token can be retrieved and managed from your accounts page.

Typically beings uk_...

startinteger

Start Timestamp

A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556452651

endinteger

End Timestamp

An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556477882

licenseestring

Licensee Key

Uniquely identifies a licensee.

Response

Success