Connect X

A platform user can connect their X account. It adds the X profile with follower counts to the user object and is required for the KOL badge.

Connect

POST /v1/platform-users/x/connect Returns an authorize_url. Send the user there, in a new tab or a redirect. They authorize with X and come back to your return_url. The URL is valid for 10 minutes and can be used once. When the connection succeeds, you receive the platform_user.x_connected webhook and the user object shows x.

string

required

Your id of the user. Alternatively pass csid_id.

string

required

Where the user goes back after X. Must be on one of your instance’s verified domains, registered origins or redirect URIs (https), or http://localhost.

curl -X POST "https://api-id.cabalspy.xyz/v1/platform-users/x/connect" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"external_id": "user_8412", "return_url": "https://app.example.com/profile"}'

import requests

r = requests.post("https://api-id.cabalspy.xyz/v1/platform-users/x/connect",
                  json={"external_id": "user_8412", "return_url": "https://app.example.com/profile"},
                  headers={"Authorization": "Bearer YOUR_KEY"})
print(r.json()["data"]["authorize_url"])

const res = await fetch("https://api-id.cabalspy.xyz/v1/platform-users/x/connect", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ external_id: "user_8412", return_url: "https://app.example.com/profile" }),
});
const { data } = await res.json();
// redirect the user to data.authorize_url

Response

{
  "success": true,
  "data": {
    "external_id": "user_8412",
    "authorize_url": "https://id.cabalspy.xyz/p/x/Kq8vN2...",
    "expires_at": "2026-10-26T08:14:11Z"
  },
  "meta": { "request_id": "req_5162c7cf7f87", "cached": false, "cache_age_seconds": 0, "version": "v1", "timestamp": "2026-10-26T08:04:11Z" }
}

Disconnect

POST /v1/platform-users/x/disconnect Removes the user’s X account. A user with the KOL badge cannot disconnect X, the badge belongs to the X account.

string

required

Your id of the user. Alternatively pass csid_id.

curl -X POST "https://api-id.cabalspy.xyz/v1/platform-users/x/disconnect" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"external_id": "user_8412"}'

Response

{
  "success": true,
  "data": { "external_id": "user_8412", "disconnected": true },
  "meta": { "request_id": "req_5162c7cf7f87", "cached": false, "cache_age_seconds": 0, "version": "v1", "timestamp": "2026-10-26T08:20:00Z" }
}

disconnected is false when the user had no X account.

Errors

Status	Code	Meaning
400	missing_parameter	external_id or return_url missing.
400	invalid_return_url	return_url is not on one of your instance’s sites.
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.
409	account_claimed	The person claimed the account and manages it themselves.
409	kol_badge	Disconnect: the user has the KOL badge.
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

Connect

Disconnect

Errors

​Connect

​Disconnect

​Errors

Connect

Disconnect

Errors