Copy settings

{
  "success": true,
  "data": [
    {
      "trader": {
        "csid_id": "7c2e9a14-6b3d-4f81-9e0a-5d4c3b2a1f09",
        "username": "MazeCCC",
        "name": "Maze",
        "image_url": "https://pbs.twimg.com/profile_images/1/maze_normal.jpg",
        "kol": true,
        "profile_url": "https://id.cabalspy.xyz/u/MazeCCC"
      },
      "copy": {
        "enabled": true,
        "mode": "fixed_usd",
        "amount_usd": 25.0,
        "percent": 100.0,
        "max_usd": 20.0,
        "sides": "both",
        "slippage_bps": 300,
        "updated_at": "2026-11-01T17:58:40Z"
      },
      "managed_by_other_platform": false
    }
  ],
  "meta": { "request_id": "req_5162c7cf7f87", "cached": false, "cache_age_seconds": 0, "version": "v1", "timestamp": "2026-11-01T18:00:00Z" }
}

{
  "success": true,
  "data": [
    {
      "trader": {
        "csid_id": "7c2e9a14-6b3d-4f81-9e0a-5d4c3b2a1f09",
        "username": "MazeCCC",
        "name": "Maze",
        "image_url": "https://pbs.twimg.com/profile_images/1/maze_normal.jpg",
        "kol": true,
        "profile_url": "https://id.cabalspy.xyz/u/MazeCCC"
      },
      "copy": {
        "enabled": true,
        "mode": "fixed_usd",
        "amount_usd": 25.0,
        "percent": 100.0,
        "max_usd": 20.0,
        "sides": "both",
        "slippage_bps": 300,
        "updated_at": "2026-11-01T17:58:40Z"
      },
      "managed_by_other_platform": false
    }
  ],
  "meta": { "request_id": "req_5162c7cf7f87", "cached": false, "cache_age_seconds": 0, "version": "v1", "timestamp": "2026-11-01T18:00:00Z" }
}

A user’s copy trading settings, one set per trader in their Trade Feed. They apply to the trader’s next trade from the moment you save them; instructions already sent are not changed. The user is a platform user (by external_id or csid_id) or a person who signed in to your app with the scope trade_feed (by csid_id), within your plan’s user limit.

Setting	Values	Default	Effect
`enabled`	`true` or `false`	`false`	Copy this trader.
`mode`	`fixed_usd` or `percent`	`fixed_usd`	How buys are sized.
`amount_usd`	Above 0, at most 1,000,000	50	`fixed_usd`: every copied buy is this many USD.
`percent`	Above 0, at most 1,000	100	`percent`: every copied buy is this share of the trader’s buy in USD. 100 is the same size as the trader.
`max_usd`	Above 0, at most 1,000,000, or null	null	Cap per copied buy, in both modes. `null` or `0` removes the cap.
`sides`	`buys` or `both`	`both`	`both`: buys and sells are copied. `buys`: only buys.
`slippage_bps`	Whole number, 1 to 5,000	300	The price limit sent with every instruction, in basis points: 300 = 3 %.

Copied buys below $1 are not sent. Sells are copied as a share of the user’s copied position, see Sizing.

Read the settings

GET /v1/copy-trading/settings All traders in the user’s Trade Feed with their copy settings, those copied first, then newest first. With trader, only that one trader as a single object.

Query Parameters

string

The user, by your own user id. Alternatively pass csid_id.

string

The user’s CabalSpy ID. Required unless you pass external_id.

string

Only this trader: a handle (with or without @) or a csid_id. Alternatively pass trader_external_id for one of your own platform users.

string

Only this trader, by your own user id of a platform user.

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/copy-trading/settings?external_id=user_8412" \
  -H "Authorization: Bearer YOUR_KEY"

import requests

r = requests.get("https://api-id.cabalspy.xyz/v1/copy-trading/settings",
                 params={"csid_id": "3f9a1c2e-5b7d-4e8f-a1b2-c3d4e5f60718", "trader": "MazeCCC"},
                 headers={"Authorization": "Bearer YOUR_KEY"})
print(r.json()["data"]["copy"])

const p = new URLSearchParams({ external_id: "user_8412" });
const res = await fetch(`https://api-id.cabalspy.xyz/v1/copy-trading/settings?${p}`, {
  headers: { Authorization: "Bearer YOUR_KEY" },
});
for (const t of (await res.json()).data) {
  console.log(t.trader.username, t.copy.enabled, t.managed_by_other_platform);
}

Response

array

One entry per trader in the user’s Trade Feed, or a single entry when you passed trader.

Show entry

object

csid_id, username, name, image_url, kol and profile_url. username and profile_url are null for platform users.

object

enabled, mode, amount_usd, percent, max_usd, sides, slippage_bps and updated_at (when the copy settings were last changed, or null).

boolean

true when another platform copies this trader for this user. You cannot switch copying on until it is switched off there, see One platform at a time.

{
  "success": true,
  "data": [
    {
      "trader": {
        "csid_id": "7c2e9a14-6b3d-4f81-9e0a-5d4c3b2a1f09",
        "username": "MazeCCC",
        "name": "Maze",
        "image_url": "https://pbs.twimg.com/profile_images/1/maze_normal.jpg",
        "kol": true,
        "profile_url": "https://id.cabalspy.xyz/u/MazeCCC"
      },
      "copy": {
        "enabled": true,
        "mode": "fixed_usd",
        "amount_usd": 25.0,
        "percent": 100.0,
        "max_usd": 20.0,
        "sides": "both",
        "slippage_bps": 300,
        "updated_at": "2026-11-01T17:58:40Z"
      },
      "managed_by_other_platform": false
    }
  ],
  "meta": { "request_id": "req_5162c7cf7f87", "cached": false, "cache_age_seconds": 0, "version": "v1", "timestamp": "2026-11-01T18:00:00Z" }
}

The same copy object is also part of each trader’s settings in GET /v1/trade-feed/traders.

Errors

Status	Code	Meaning
400	missing_parameter	Neither csid_id nor external_id was passed.
400	invalid_parameter	csid_id is not a valid id.
401	missing_api_key	API key missing.
403	invalid_api_key	API key invalid or not enabled for CabalSpy ID.
403	consent_required	The user has not granted your app the scope `trade_feed`, or is beyond your plan’s user limit.
403	plan_user_limit	The user signed in beyond your plan’s user limit.
404	platform_user_not_found	No platform user with this external_id or trader_external_id.
404	trader_not_found	No CabalSpy ID trader with this handle or csid_id.
404	not_in_trade_feed	The trader is not in the user’s Trade Feed.
429	rate_limit_exceeded	Rate limit exceeded.

Change the settings

POST /v1/copy-trading/settings Changes the copy settings of one user for one trader. Send only the settings you want to change, at least one of them. If the trader is not in the user’s Trade Feed yet, they are added first (with the user’s default alert settings) and the response has status 201; otherwise 200. Switching copying on ("enabled": true) makes your instance the platform that copies this trader for this user. While another platform copies the trader for the user, the request is refused with 409 copy_managed_elsewhere. Each call counts towards the user’s Trade Feed changes, at most 120 per hour.

Body

string

The user, by your own user id. Alternatively pass csid_id.

string

The user’s CabalSpy ID. Required unless you pass external_id.

string

required

The trader to copy: a handle (with or without @) or a csid_id. Alternatively pass trader_external_id.

string

The trader, by your own user id of one of your platform users.

boolean

true to copy this trader, false to stop.

string

fixed_usd or percent.

number

USD per copied buy in fixed_usd mode. Above 0, at most 1,000,000.

number

Share of the trader’s buy in percent mode. Above 0, at most 1,000.

number

Cap per copied buy. Above 0, at most 1,000,000. null or 0 removes the cap.

string

buys or both.

integer

Whole number from 1 to 5,000.

string

required

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

Usage Example

curl -X POST "https://api-id.cabalspy.xyz/v1/copy-trading/settings" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"external_id": "user_8412", "trader": "MazeCCC", "enabled": true, "mode": "fixed_usd", "amount_usd": 25, "max_usd": 20}'

import requests

# copy 10 % of every buy, no cap, buys only
r = requests.post("https://api-id.cabalspy.xyz/v1/copy-trading/settings",
                  json={"csid_id": "3f9a1c2e-5b7d-4e8f-a1b2-c3d4e5f60718", "trader": "MazeCCC",
                        "enabled": True, "mode": "percent", "percent": 10, "max_usd": None, "sides": "buys"},
                  headers={"Authorization": "Bearer YOUR_KEY"})
print(r.status_code, r.json()["data"]["copy"])

// stop copying
const res = await fetch("https://api-id.cabalspy.xyz/v1/copy-trading/settings", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ external_id: "user_8412", trader: "MazeCCC", enabled: false }),
});
console.log((await res.json()).data.copy.enabled);

Response

The trader’s entry as in Read the settings: trader, copy and managed_by_other_platform.

Response

{
  "success": true,
  "data": {
    "trader": {
      "csid_id": "7c2e9a14-6b3d-4f81-9e0a-5d4c3b2a1f09",
      "username": "MazeCCC",
      "name": "Maze",
      "image_url": "https://pbs.twimg.com/profile_images/1/maze_normal.jpg",
      "kol": true,
      "profile_url": "https://id.cabalspy.xyz/u/MazeCCC"
    },
    "copy": {
      "enabled": true,
      "mode": "fixed_usd",
      "amount_usd": 25.0,
      "percent": 100.0,
      "max_usd": 20.0,
      "sides": "both",
      "slippage_bps": 300,
      "updated_at": "2026-11-01T17:58:40Z"
    },
    "managed_by_other_platform": false
  },
  "meta": { "request_id": "req_5162c7cf7f87", "cached": false, "cache_age_seconds": 0, "version": "v1", "timestamp": "2026-11-01T17:58:40Z" }
}

Errors

Status	Code	Meaning
400	missing_parameter	No user, no trader, or none of the settings was sent (`parameter` is then `enabled`).
400	invalid_parameter	A setting has the wrong type or is out of range. `parameter` names it.
400	cannot_add_self	The user and the trader are the same person.
401	missing_api_key	API key missing.
403	invalid_api_key	API key invalid or not enabled for CabalSpy ID.
403	consent_required	The user has not granted your app the scope `trade_feed`, or is beyond your plan’s user limit.
403	trading_private	The trader keeps their trading private.
404	platform_user_not_found	No platform user with this external_id or trader_external_id.
404	trader_not_found	No CabalSpy ID trader with this handle or csid_id.
409	copy_managed_elsewhere	Another platform copies this trader for this user. It has to be switched off there first.
409	trade_feed_full	The trader would have to be added, and the user’s Trade Feed already has 300 traders.
429	rate_limited	More than 120 Trade Feed changes for this user in an hour.
429	rate_limit_exceeded	Rate limit exceeded.

See Errors for the full list.

Introduction

Login

Data API

Users

Trading

Theses

Streams

White-Label

Competitions

Callouts

Trade Feed

Copy trading

Reference

Read the settings

Query Parameters

Usage Example

Response

Errors

Change the settings

Body

Usage Example

Response

Errors

​Read the settings

​Query Parameters

​Usage Example

​Response

​Errors

​Change the settings

​Body

​Usage Example

​Response

​Errors

Read the settings

Query Parameters

Usage Example

Response

Errors

Change the settings

Body

Usage Example

Response

Errors