Settings

{
  "success": true,
  "data": {
    "name": "Example Terminal",
    "white_label": true,
    "data_scope": "csid",
    "network_sharing": true,
    "wallet_trust": "all",
    "leaderboard_trust": "verified_only",
    "claim_links": false,
    "telegram_alerts": false,
    "inbound": { "enabled": true, "last_event_at": "2026-10-26T07:58:02Z" }
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

{
  "success": true,
  "data": {
    "name": "Example Terminal",
    "white_label": true,
    "data_scope": "csid",
    "network_sharing": true,
    "wallet_trust": "all",
    "leaderboard_trust": "verified_only",
    "claim_links": false,
    "telegram_alerts": false,
    "inbound": { "enabled": true, "last_event_at": "2026-10-26T07:58:02Z" }
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

Read and change the White-Label settings of your instance. A POST changes only the settings you pass and returns all of them. See Settings in the overview for what each one does. The same settings are on the instance’s White-label tab in the dashboard. Saving them there always sends all of them, including claim_links.

Read the settings

GET /v1/platform-users/settings

curl "https://api-id.cabalspy.xyz/v1/platform-users/settings" \
  -H "Authorization: Bearer YOUR_KEY"

Change the settings

POST /v1/platform-users/settings

boolean

Dashboard: No CabalSpy ID branding. The verify widget and the texts your users see do not mention CabalSpy ID. While claim_links has never been set, claim links are off when this is true and on when it is false.

string

Dashboard: Where your users’ data is visible. csid (default): your users are part of the CabalSpy ID network: profiles, leaderboard, Trade Feed and theses. platform: only your instance sees them, nothing appears on CabalSpy ID’s public pages or other platforms.

string

Dashboard: Wallets that count. all: unverified wallets you send count for data, profiles and leaderboards. verified_only: only payment-verified wallets count; unverified ones get the status needs_verification.

string

Dashboard: Leaderboard. all or verified_only: which wallets the platform leaderboard ranks. trust=verified on the leaderboard request can only narrow it further.

boolean

Dashboard: Claim links. Whether you can create claim links. When off, creating one returns claim_disabled.

boolean

Dashboard: Telegram alerts for your users. Trade Feed alerts through the CabalSpy ID Telegram bot for platform users who linked Telegram.

Older form of data_scope: true is csid, false is platform.

Unknown settings are refused with invalid_parameter, which lists the allowed ones.

curl -X POST "https://api-id.cabalspy.xyz/v1/platform-users/settings" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"wallet_trust": "all", "leaderboard_trust": "verified_only", "claim_links": false}'

import requests

r = requests.post("https://api-id.cabalspy.xyz/v1/platform-users/settings",
                  json={"data_scope": "platform"},
                  headers={"Authorization": "Bearer YOUR_KEY"})
print(r.json()["data"])

const res = await fetch("https://api-id.cabalspy.xyz/v1/platform-users/settings", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ white_label: true }),
});
const { data } = await res.json();
console.log(data.white_label, data.claim_links);

Response

string

The instance’s name.

boolean

White-label flag.

string

csid or platform.

The same as data_scope, as a boolean.

string

all or verified_only.

string

all or verified_only.

boolean

Whether claim links are on, including the default from white_label.

boolean

Telegram alerts on or off.

object

enabled and last_event_at of the inbound URL.

{
  "success": true,
  "data": {
    "name": "Example Terminal",
    "white_label": true,
    "data_scope": "csid",
    "network_sharing": true,
    "wallet_trust": "all",
    "leaderboard_trust": "verified_only",
    "claim_links": false,
    "telegram_alerts": false,
    "inbound": { "enabled": true, "last_event_at": "2026-10-26T07:58:02Z" }
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

Errors

Status	Code	Meaning
400	invalid_parameter	Unknown setting, or a value that is not allowed. `allowed` lists the accepted values.
401	missing_api_key	API key missing.
403	invalid_api_key	API key invalid or not enabled for CabalSpy ID.
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

Read the settings

Change the settings

Response

Errors

​Read the settings

​Change the settings

​Response

​Errors

Read the settings

Change the settings

Response

Errors