Base URL
Authentication
Pass your key in theAuthorization header. Both forms work:
wts_live_ and are stored only as hashes. A lost key is replaced, not recovered.
Plans
API access is included with the Pro and Unlimited tiers rather than sold separately.Responses from
/v1/usage report the plan name
(Developer, Startup), which does not match the tier name you purchased
(Pro, Unlimited). The mapping above is the whole of it.Credits
Rate limits are consumed in credits, not requests. Most endpoints cost one credit, but two do not.
Batch is charged on the number of addresses you submit, before duplicates are removed. Deduplicate your own list first, or you will pay for the same address twice and receive it once.
Reverse lookups cost double because they scan the index by identity rather than by key.
Response shape
Every successful response is an object withdata and meta.
data holds the result and is null or [] when there is nothing to return. meta holds everything about the request itself: what you asked for, how much came back, whether it was truncated.
Two conventions are worth internalising:
Absent fields are omitted, not nulled. A wallet with no GitHub account has no github key at all. Check for presence.
Not found is not an error. A wallet we have no identities for returns HTTP 200 with data: null and meta.found: false. Error status codes are reserved for requests that actually failed.
Conventions
- Wallet addresses are accepted in any case and returned lowercased.
- X handles are accepted with or without a leading
@and returned without it. - All timestamps are ISO 8601 in UTC.
OPTIONSis supported on every endpoint for CORS preflight.