Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
{
"success": true,
"data": {
"instance": "example.com",
"client_id": "csid_3f9a1c0e7b2d4a6f8e1c5b09",
"mode": "live",
"plan": "pro",
"rate_limit_rps": 10,
"websockets": true,
"global_scope": false,
"users_with_data": 128
},
"meta": {
"request_id": "req_5162c7cf7f87",
"cached": false,
"cache_age_seconds": 0,
"version": "v1",
"timestamp": "2026-10-13T08:04:11Z"
}
}
GET /v1/me: the instance your API key works with, its plan, request rate and how many users you receive data for.
{
"success": true,
"data": {
"instance": "example.com",
"client_id": "csid_3f9a1c0e7b2d4a6f8e1c5b09",
"mode": "live",
"plan": "pro",
"rate_limit_rps": 10,
"websockets": true,
"global_scope": false,
"users_with_data": 128
},
"meta": {
"request_id": "req_5162c7cf7f87",
"cached": false,
"cache_age_seconds": 0,
"version": "v1",
"timestamp": "2026-10-13T08:04:11Z"
}
}
csid_...). Only needed when your account has several instances.curl "https://api-id.cabalspy.xyz/v1/me" \
-H "Authorization: Bearer YOUR_KEY"
import requests
r = requests.get("https://api-id.cabalspy.xyz/v1/me",
headers={"Authorization": "Bearer YOUR_KEY"})
d = r.json()["data"]
print(d["plan"], d["rate_limit_rps"], "rps,", d["users_with_data"], "users")
const res = await fetch("https://api-id.cabalspy.xyz/v1/me", {
headers: { Authorization: "Bearer YOUR_KEY" },
});
const { data } = await res.json();
console.log(data.plan, data.rate_limit_rps, data.users_with_data);
Show data
sandbox, development or live.free, starter, pro, business or enterprise for live instances, development otherwise.scope=global is available (Enterprise).{
"success": true,
"data": {
"instance": "example.com",
"client_id": "csid_3f9a1c0e7b2d4a6f8e1c5b09",
"mode": "live",
"plan": "pro",
"rate_limit_rps": 10,
"websockets": true,
"global_scope": false,
"users_with_data": 128
},
"meta": {
"request_id": "req_5162c7cf7f87",
"cached": false,
"cache_age_seconds": 0,
"version": "v1",
"timestamp": "2026-10-13T08:04:11Z"
}
}
| Status | Code | Meaning |
|---|---|---|
| 400 | instance_required | Your account has several instances, pass instance. |
| 401 | missing_api_key | API key missing. |
| 403 | invalid_api_key | API key invalid or does not exist. |
| 403 | product_not_enabled | CabalSpy ID is not enabled for this key. |
| 403 | no_instance | Create a CabalSpy ID instance first. |
| 404 | instance_not_found | No instance with this client_id in your account. |
| 429 | rate_limit_exceeded | Rate limit exceeded. |