Documentation Index
Fetch the complete documentation index at: https://cryptorobot.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
Quick Start with the Client SDK
The recommended way to interact with the Cryptorobot.ai API is via the official@cryptorobot.ai/client npm package over WebSockets. This gives you real-time events, typed services, and automatic reconnection.
The client SDK supports both WebSocket (recommended) and REST transports. WebSocket provides real-time event streaming and lower latency.
REST API
For direct HTTP access, use the base URL:Authentication
All authenticated endpoints require one of:HTTP Methods
| Method | Service Method | Description |
|---|---|---|
GET /service | find | List resources (paginated) |
GET /service/:id | get | Get a single resource |
POST /service | create | Create a new resource |
PATCH /service/:id | patch | Partially update a resource |
DELETE /service/:id | remove | Delete a resource |
Common Query Parameters
| Parameter | Type | Description |
|---|---|---|
$limit | integer | Items per page (default: 25, max: 100) |
$skip | integer | Items to skip for pagination |
$sort[field] | 1 | -1 | Sort direction (1 = ascending, -1 = descending) |
$select[] | string | Fields to include in response |
field[$operator] | varies | Filter operator: $gt, $gte, $lt, $lte, $ne, $in, $nin |
Response Format
Paginated List (Find)
Single Resource (Get / Create / Patch)
Error
Rate Limits
| Header | Description |
|---|---|
X-RateLimit-Limit | Max requests per minute |
X-RateLimit-Remaining | Remaining in current window |
X-RateLimit-Reset | Unix timestamp when window resets |
Retry-After | Seconds to wait (429 responses only) |

