Overview

Platform Architecture

Cryptorobot.ai is built on a real-time microservices architecture. The API supports both REST and WebSocket transports, giving you flexibility in how you consume data.

Transports

REST API

Standard HTTP requests with JSON responses. Best for CRUD operations, one-off queries, and server-to-server integration.

WebSocket

Persistent connections with real-time event streaming. Best for live price feeds, trade notifications, and bot status updates.

REST Conventions

The API follows RESTful conventions for all resources:

Action	HTTP Method	Path	Description
Find	`GET`	`/resource`	List resources (paginated)
Get	`GET`	`/resource/:id`	Get a single resource
Create	`POST`	`/resource`	Create a new resource
Patch	`PATCH`	`/resource/:id`	Partially update a resource
Remove	`DELETE`	`/resource/:id`	Delete a resource

Pagination

All find (list) endpoints return paginated results:

{
  "total": 142,
  "limit": 25,
  "skip": 0,
  "data": [...]
}

Use query parameters to control pagination:

Parameter	Type	Default	Description
`$limit`	integer	25	Max items per page (max 100)
`$skip`	integer	0	Number of items to skip
`$sort[field]`	1 or -1	—	Sort by field (1=asc, -1=desc)
`$select[]`	string	—	Fields to include in response

Filtering

Query parameters support rich filtering:

# Find strategies where type is "momentum"
GET /strategies?type=momentum

# Find trades after a date
GET /trades?createdAt[$gte]=2024-01-01

# Find with multiple conditions
GET /exchanges?active=true&$sort[createdAt]=-1&$limit=10

Supported operators: $gt, $gte, $lt, $lte, $ne, $in, $nin, $or.

Core Resources

Exchanges

Exchange connections represent your linked cryptocurrency exchange accounts (Binance, Bybit, OKX, etc.). Through these, you can fetch balances, market data, and execute trades.

Strategies

Trading strategies define the rules for automated trading. They include technical indicators, entry/exit conditions, and risk parameters. Strategies can be backtested, optimized with hyperparameter tuning, or generated by AI.

Traders & Pods

Traders are live trading bot instances. Each trader runs inside a Pod — an isolated execution environment with its own configuration, API keys, and event stream.

Models & Signals

Machine learning models that generate trading signals. You can subscribe to signals and receive real-time notifications when conditions are met.

Insights

Market intelligence data including ETF flows, fear & greed index, crypto stress index, global market stats, and curated news feeds.

Portfolio

Aggregate view of your holdings across all connected exchanges, including balance time-series, performance metrics, and trade history.

Data Flow

Rate Limits

Tier	Requests/min	WebSocket connections
Free	60	1
Pro	300	5
Enterprise	1000	25

See Errors & Rate Limits for details on handling rate limit responses.

Getting Started

Authentication

Core Concepts

Platform Architecture

Transports

REST API

WebSocket

REST Conventions

Filtering

Core Resources

Data Flow

Rate Limits

​Platform Architecture

​Transports

REST API

WebSocket

​REST Conventions

​Pagination

​Filtering

​Core Resources

​Data Flow

​Rate Limits

Platform Architecture

Transports

REST Conventions

Pagination

Filtering

Core Resources

Data Flow

Rate Limits