Skip to main content
This guide takes your existing users and their wallets, from Privy, Dynamic or your own database, to a profile page, a leaderboard and a running trading competition. All calls go from your backend to the Data API with your API key.
1

Get an API key for your instance

No dashboard account yet? Create one and get your API key. Then open the CabalSpy ID tab and create an instance:
  • Type: server-side web app. All White-Label calls come from your backend.
  • Start in: development. Your platform users have real wallets and real trades.
  • Redirect URIs: leave empty. They are only for Login with CabalSpy ID.
Your API key works for CabalSpy ID by default (Works with on the API keys page), see Authentication. Check it with GET /v1/me. If your account has several instances, add instance=csid_... to every call; the SDKs take it once in the constructor.A development instance holds up to 25 platform users and allows 1 request per second, enough to build and test. A live instance uses your plan’s limits, see Going live.
2

Import your users

Send your users with your own user id as external_id and their existing wallets. Up to 1,000 users per call and 2,000 new users per minute. Each user is handled on its own, so one bad entry never undoes the others. While the instance is in development, try it with a few users (it holds 25) and import everyone after going live.
For users who sign up later, call Create or update a user from your sign-up flow, or let Privy, Dynamic or your backend post sign-ups to your inbound URL.
3

Show a profile

One call returns everything for a profile page: the user, their wallets, trading stats per chain for a period, the 20 most recent trades, theses and the KOL status.
For charts and detail pages, every other Data API endpoint accepts external_id in place of csid_id, for example tracker, holdings, history and the PnL calendar. The profile’s links field has the ready-made paths for each wallet. See Platform user profile.
4

Rank your users

The platform leaderboard ranks the wallets of your users and tells you whose wallet each entry is, by external_id.
To rank only payment-verified wallets, add trust=verified or set leaderboard_trust to verified_only in the settings. See Platform leaderboard.
5

Start a competition

Create a 48-hour PnL competition on Solana that enters every user automatically.
Once it runs, read the standings, recomputed every 5 minutes, or subscribe to the competition.standings and competition.ended webhooks. See Competitions.

What to build where

You build your own UI. Everything works through the Data API with external_id; one widget is ready to embed.

Embed the wallet verification widget

Create a session for the user on your backend and pass session and client_id to the page. The widget shows the amount, the address and a QR code, and updates when the payment arrives.
Optional attributes: data-theme (dark or light), data-accent (a hex color), data-radius (0-24), data-frameless, data-compact and data-height. A session lasts 15 minutes; create a new one when the user reloads the page. The widget only loads on your instance’s sites and on localhost while the instance is not live.

Going live

A live instance uses your plan instead of the development limits (25 users, 1 request per second). In the dashboard, the instance’s Overview shows what is still missing. For White-Label you need:
  1. A verified domain (Domains & testers, DNS TXT record or a file on your website). It also carries your plan.
  2. Website, privacy policy and terms URLs on your verified domain and a support e-mail (Settings, Branding), and a logo (Settings, Logo: square PNG, JPEG or WebP, at most 256 KB).
  3. Go live on the Overview tab.
Redirect URIs, testers and the login button are only needed for Login with CabalSpy ID. If you also request the scopes wallets or onchain for a login, explain why in Settings; those need a short review.

Next steps