List and detail

List competitions

GET /v1/competitions The competitions of your instance, newest first, as competition objects without the rules history.

Query Parameters

string

Only competitions in this status: scheduled, waiting, running, ended or cancelled.

integer

default:"50"

Competitions per page, 1 to 500.

integer

default:"0"

How many to skip.

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.

This list is paged with offset, not with a cursor. Compare offset + limit with pagination.total to know whether more follow.

Usage Example

curl "https://api-id.cabalspy.xyz/v1/competitions?status=running" \
  -H "Authorization: Bearer YOUR_KEY"

import requests

r = requests.get("https://api-id.cabalspy.xyz/v1/competitions",
                 params={"limit": 50, "offset": 0},
                 headers={"Authorization": "Bearer YOUR_KEY"}).json()
for c in r["data"]:
    print(c["id"], c["name"], c["status"], c["participants"])
print("total", r["pagination"]["total"])

const p = new URLSearchParams({ status: "scheduled" });
const res = await fetch(`https://api-id.cabalspy.xyz/v1/competitions?${p}`, {
  headers: { Authorization: "Bearer YOUR_KEY" },
});
const { data, pagination } = await res.json();
console.log(data.map(c => c.name), pagination.total);

Response

{
  "success": true,
  "data": [
    {
      "id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
      "name": "Weekend PnL Cup",
      "chain": "solana",
      "metric": "pnl_usd",
      "status": "running",
      "started_at": "2026-11-01T18:00:00Z",
      "ends_at": "2026-11-03T18:00:00Z",
      "participants": 214,
      "rules_version": 1,
      "standings_updated_at": "2026-11-02T09:15:00Z",
      "...": "the other fields of the competition object"
    }
  ],
  "pagination": { "limit": 50, "total": 1, "has_more": false, "next_cursor": null },
  "meta": { "request_id": "req_5162c7cf7f87", "cached": false, "cache_age_seconds": 0, "version": "v1", "timestamp": "2026-11-02T09:16:02Z" }
}

Competition detail

GET /v1/competitions/detail?id=<competition id> One competition, as the competition object including every rule change.

string

required

The competition id.

curl "https://api-id.cabalspy.xyz/v1/competitions/detail?id=9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f" \
  -H "Authorization: Bearer YOUR_KEY"

import requests

c = requests.get("https://api-id.cabalspy.xyz/v1/competitions/detail",
                 params={"id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f"},
                 headers={"Authorization": "Bearer YOUR_KEY"}).json()["data"]
for ch in c["changes"]:
    print(ch["rules_version"], ch["during"], ch["changes"], ch["note"])

const p = new URLSearchParams({ id: "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f" });
const res = await fetch(`https://api-id.cabalspy.xyz/v1/competitions/detail?${p}`, {
  headers: { Authorization: "Bearer YOUR_KEY" },
});
const { data } = await res.json();
console.log(data.status, data.changed_while_running);

Rules history

array

Show change

integer

The rules version this change created.

string

When it was changed.

string

The phase it was changed in: scheduled or running.

object

Per changed field: from and to. Durations are shown as duration_hours.

string

Your note on the change, or null.

boolean

Whether any rule was changed while the competition ran.

Response

{
  "success": true,
  "data": {
    "id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
    "name": "Weekend PnL Cup",
    "status": "running",
    "duration_hours": 72.0,
    "ends_at": "2026-11-04T18:00:00Z",
    "rules_version": 2,
    "...": "the other fields of the competition object",
    "changes": [
      {
        "rules_version": 2,
        "changed_at": "2026-11-02T10:00:00Z",
        "during": "running",
        "changes": { "duration_hours": { "from": 48.0, "to": 72.0 } },
        "note": "Extended by one day after the outage."
      }
    ],
    "changed_while_running": true
  },
  "meta": { "request_id": "req_5162c7cf7f87", "cached": false, "cache_age_seconds": 0, "version": "v1", "timestamp": "2026-11-02T10:00:05Z" }
}

Errors

Status	Code	Meaning
400	missing_parameter	Detail: id missing.
400	invalid_parameter	status, limit, offset or id invalid.
401	missing_api_key	API key missing.
403	invalid_api_key	API key invalid or not enabled for CabalSpy ID.
404	competition_not_found	No competition 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

List competitions

Query Parameters

Usage Example

Competition detail

Rules history

Errors

​List competitions

​Query Parameters

​Usage Example

​Competition detail

​Rules history

​Errors

List competitions

Query Parameters

Usage Example

Competition detail

Rules history

Errors