API reference · v1

Check access and allowance

Validate your key and view shared account allowance. Does not consume monthly quota; minute rate limits still apply.

GET/v1/me

Send a secret API key in Authorization: Bearer YOUR_API_KEY. This endpoint does not consume monthly quota.

Parameters

This endpoint accepts no query parameters.

Response fields

accountIdstring

Authenticated account identifier.

keyobject

Value from the collected source record.

Show object fields

idstring

Authenticated key identifier.

namestring

Key name chosen by its owner.

prefixstring

Non-secret identifying prefix; never the full key.

allowanceobject

Value from the collected source record.

Show object fields

limitnumber

Successful data requests per UTC calendar month.

usedinteger

Successful data requests committed this month.

remaininginteger

Available requests after successful and currently reserved requests.

resetsAtstring

Next monthly reset at midnight UTC on the first day.

rateLimitnumber

Requests permitted per fixed UTC minute.

rateRemaininginteger

Requests remaining in the current minute.

rateResetsAtstring

UTC timestamp when the current minute limit resets.

Errors

Error codes, request IDs, retry behaviour, and allowance headers apply to every endpoint. Invalid or repeated query parameters return 400; unavailable records return 404. Source failures never become successful empty results.