blockchain, address and period parameters. Wallet statistics are computed exactly like the CabalSpy API, so a wallet shows the same numbers on both.
Base URL
Authentication
The Data API uses the same API key as the CabalSpy API. In the API Dashboard, open the API keys page: every key shows Works with: CabalSpy API / CabalSpy ID API, both on by default. A key with CabalSpy ID switched off is refused withproduct_not_enabled. No key yet? See API key.
Pass the key as an Authorization Bearer header or as the apiKey or api_key query parameter, the same as on the CabalSpy API.
Instance
A key works with one CabalSpy ID instance at a time. If your account has a single instance, nothing else is needed. With several instances, addinstance=<client_id> to every request, otherwise the API answers instance_required and lists your instances.
Scope: who a key can see
A key sees the users of its instance only:- Live instances: the users who signed in to any live app on your registrable domain, within your plan’s user limit.
- Development and sandbox instances: the users who signed in to that app.
profile_not_found or wallet_not_found.
On the Enterprise plan, add scope=global to see every CabalSpy ID user. Other plans get scope_not_allowed.
External ID
If you use White-Label,external_id, your own id of a platform user, works wherever csid_id does, on every endpoint, as a query parameter and in request bodies. The API looks up the user in your instance and uses their csid_id.
external_id or csid_id, not both. An unknown external_id returns 404 platform_user_not_found.
Response format
Every successful response has the same envelope.Success
pagination is only present on list endpoints. meta.cached and meta.cache_age_seconds show whether the data came from the short-lived cache.
Errors carry a machine-readable code, a message, the request id and a link to the error reference.
Error
Pagination
List endpoints are cursor based. Readnext_cursor from the response and pass it back as cursor to get the next page. When next_cursor is null, or has_more is false, you have reached the end.
Rate-limit headers
Every authenticated response carries the limit of your plan.
Above the limit the API answers
429 rate_limit_exceeded with Retry-After: 1. See Plans and limits.
Common parameters
Endpoints
You can try every endpoint in the sandbox in the dashboard on the CabalSpy ID tab.

