Get and list users

{
  "success": true,
  "data": {
    "csid_id": "3f9a1c2e-5b7d-4e8f-a1b2-c3d4e5f60718",
    "external_id": "user_8412",
    "claimed": false,
    "claimed_at": null,
    "managed": true,
    "display_name": "Maze",
    "avatar_url": "https://cdn.example.com/avatars/8412.png",
    "limited": false,
    "x": null,
    "telegram": null,
    "kol": { "badge": false, "since": null },
    "wallets": [
      {
        "address": "7j7AA3HZR2zEjwAQEKPFh2qucLY4fqZpB9iodf39w8xW",
        "family": "solana",
        "chains": ["solana"],
        "verified": false,
        "verified_chains": [],
        "status": "active",
        "counts": true,
        "source": "privy",
        "verified_at": null,
        "added_at": "2026-10-24T09:12:40Z"
      },
      {
        "address": "0x4b1e9c0d2a7f3e5b8c6d1a9f0e2b7c4d5a6e8f01",
        "family": "evm",
        "chains": ["base", "bnb", "eth", "rh"],
        "verified": true,
        "verified_chains": ["base"],
        "status": "verified",
        "counts": true,
        "source": null,
        "verified_at": "2026-10-25T16:02:11Z",
        "added_at": "2026-10-24T09:12:40Z"
      }
    ],
    "pending_verifications": [],
    "created_at": "2026-10-24T09:12:40Z"
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

{
  "success": true,
  "data": {
    "csid_id": "3f9a1c2e-5b7d-4e8f-a1b2-c3d4e5f60718",
    "external_id": "user_8412",
    "claimed": false,
    "claimed_at": null,
    "managed": true,
    "display_name": "Maze",
    "avatar_url": "https://cdn.example.com/avatars/8412.png",
    "limited": false,
    "x": null,
    "telegram": null,
    "kol": { "badge": false, "since": null },
    "wallets": [
      {
        "address": "7j7AA3HZR2zEjwAQEKPFh2qucLY4fqZpB9iodf39w8xW",
        "family": "solana",
        "chains": ["solana"],
        "verified": false,
        "verified_chains": [],
        "status": "active",
        "counts": true,
        "source": "privy",
        "verified_at": null,
        "added_at": "2026-10-24T09:12:40Z"
      },
      {
        "address": "0x4b1e9c0d2a7f3e5b8c6d1a9f0e2b7c4d5a6e8f01",
        "family": "evm",
        "chains": ["base", "bnb", "eth", "rh"],
        "verified": true,
        "verified_chains": ["base"],
        "status": "verified",
        "counts": true,
        "source": null,
        "verified_at": "2026-10-25T16:02:11Z",
        "added_at": "2026-10-24T09:12:40Z"
      }
    ],
    "pending_verifications": [],
    "created_at": "2026-10-24T09:12:40Z"
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

Read one of your platform users by your own id, or page through all of them. The user object carries the identity, the wallets with their trust status, X, Telegram, the KOL badge and open wallet verifications. Trading data is in the profile.

Get a user

GET /v1/platform-users

Query Parameters

string

Your id of the user. Pass this or csid_id.

string

The user’s CabalSpy ID account id.

string

Your Instance ID. Only needed when your account has several instances.

string

required

Your API key. Alternatively pass it as an Authorization Bearer header.

Usage Example

curl "https://api-id.cabalspy.xyz/v1/platform-users?external_id=user_8412" \
  -H "Authorization: Bearer YOUR_KEY"

import requests

r = requests.get("https://api-id.cabalspy.xyz/v1/platform-users",
                 params={"external_id": "user_8412"},
                 headers={"Authorization": "Bearer YOUR_KEY"})
u = r.json()["data"]
print(u["csid_id"], [(w["address"], w["status"]) for w in u["wallets"]])

const p = new URLSearchParams({ external_id: "user_8412" });
const res = await fetch(`https://api-id.cabalspy.xyz/v1/platform-users?${p}`, {
  headers: { Authorization: "Bearer YOUR_KEY" },
});
const { data } = await res.json();
console.log(data.csid_id, data.wallets.map(w => w.status));

Response

boolean

True on success.

object

Show user

string

The CabalSpy ID account id. Changes to the person’s own account id when they claim it.

string

Your id of the user.

boolean

Whether the person took the account into their own CabalSpy ID with a claim link.

string

When it was claimed, or null.

boolean

True while the account is managed by your instance, false after a claim.

string

Display name, or null.

string

Avatar URL, or null.

boolean

True when the user has no seat in your plan’s user limit, so you receive no data for them.

object

Connected X account, or null: id, username, name, avatar_url, followers, following, verified, verified_type, created_at (of the X account) and url.

object

Linked Telegram account, or null: username, name and linked_at.

object

badge (boolean) and since (when it was granted, or null).

array

Show wallet

string

Wallet address.

string

solana or evm.

array

Every chain the wallet is tracked or verified on.

boolean

Whether it is payment-verified on at least one chain.

array

Chains it is payment-verified on.

string

verified, active, needs_verification, verified_elsewhere or pending. See Unverified and verified wallets.

boolean

Whether the wallet counts for data, profiles and leaderboards (status verified or active).

string

The source you sent with the wallet, or null.

string

When it was verified, or null.

string

When it was added.

array

Open payment verifications, each the verification object.

string

When you added the user.

{
  "success": true,
  "data": {
    "csid_id": "3f9a1c2e-5b7d-4e8f-a1b2-c3d4e5f60718",
    "external_id": "user_8412",
    "claimed": false,
    "claimed_at": null,
    "managed": true,
    "display_name": "Maze",
    "avatar_url": "https://cdn.example.com/avatars/8412.png",
    "limited": false,
    "x": null,
    "telegram": null,
    "kol": { "badge": false, "since": null },
    "wallets": [
      {
        "address": "7j7AA3HZR2zEjwAQEKPFh2qucLY4fqZpB9iodf39w8xW",
        "family": "solana",
        "chains": ["solana"],
        "verified": false,
        "verified_chains": [],
        "status": "active",
        "counts": true,
        "source": "privy",
        "verified_at": null,
        "added_at": "2026-10-24T09:12:40Z"
      },
      {
        "address": "0x4b1e9c0d2a7f3e5b8c6d1a9f0e2b7c4d5a6e8f01",
        "family": "evm",
        "chains": ["base", "bnb", "eth", "rh"],
        "verified": true,
        "verified_chains": ["base"],
        "status": "verified",
        "counts": true,
        "source": null,
        "verified_at": "2026-10-25T16:02:11Z",
        "added_at": "2026-10-24T09:12:40Z"
      }
    ],
    "pending_verifications": [],
    "created_at": "2026-10-24T09:12:40Z"
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

List users

GET /v1/platform-users/list All platform users of your instance, newest first, each as the user object above.

Read pagination.next_cursor from the response and pass it back as cursor to fetch the next page. When next_cursor is null you have reached the end.

Query Parameters

integer

default:"50"

Users per page, 1 to 100.

string

Cursor for the next page, the pagination.next_cursor from the previous response.

string

Your Instance ID. Only needed when your account has several instances.

string

required

Your API key. Alternatively pass it as an Authorization Bearer header.

Usage Example

curl "https://api-id.cabalspy.xyz/v1/platform-users/list?limit=100" \
  -H "Authorization: Bearer YOUR_KEY"

import requests

H = {"Authorization": "Bearer YOUR_KEY"}
params = {"limit": 100}
while True:
    r = requests.get("https://api-id.cabalspy.xyz/v1/platform-users/list", params=params, headers=H).json()
    for u in r["data"]:
        print(u["external_id"], len(u["wallets"]), "wallets")
    if not r["pagination"]["next_cursor"]:
        break
    params["cursor"] = r["pagination"]["next_cursor"]

const p = new URLSearchParams({ limit: "100" });
const res = await fetch(`https://api-id.cabalspy.xyz/v1/platform-users/list?${p}`, {
  headers: { Authorization: "Bearer YOUR_KEY" },
});
const { data, pagination } = await res.json();
console.log(data.length, pagination.total, pagination.next_cursor);

Response

data is an array of user objects. pagination has limit, total (all platform users of the instance), has_more and next_cursor.

Errors

Status	Code	Meaning
400	missing_parameter	Neither external_id nor csid_id was passed.
400	invalid_parameter	external_id, csid_id, limit or cursor invalid.
401	missing_api_key	API key missing.
403	invalid_api_key	API key invalid or not enabled for CabalSpy ID.
404	platform_user_not_found	No user with this id in your instance.
429	rate_limit_exceeded	Rate limit exceeded.

See Errors for the full list.

Introduction

Login

Data API

Users

Trading

Theses

Streams

White-Label

Competitions

Reference

Get and list users

Get a user

Query Parameters

Usage Example

Response

List users

Query Parameters

Usage Example

Response

Errors

​Get a user

​Query Parameters

​Usage Example

​Response

​List users

​Query Parameters

​Usage Example

​Response

​Errors

Get a user

Query Parameters

Usage Example

Response

List users

Query Parameters

Usage Example

Response

Errors