Back

DOCUMENTATION

Getting Started

Cerulon provides real-time order flow analysis and trading signals through a simple API. Connect to the platform, configure your trading parameters, and let your co-pilot monitor opportunities in real time.

npm install @cerulon/client

Core Concepts

Signal Streams

Real-time feeds of trading opportunities detected by the order flow analysis engine. Each signal includes confidence scores, entry points, and suggested risk parameters.

• Latency: 50-200ms from order book update

• Signal types: Breakout, Reversal, Momentum, Liquidity

• History: 30 days of signal performance data

Trading Parameters

User-defined rules that govern automated execution. Set risk limits, profit targets, position sizing, and stop loss criteria. All parameters are enforced strictly.

• Risk per trade: 0.5-5% of account balance

• Maximum concurrent positions: 1-10

• Auto-exit: Time-based, profit target, or stop loss

API Endpoints

GET/v1/signals/stream

Subscribe to real-time trading signals for specified markets and parameters.

POST/v1/parameters/configure

Set or update trading parameters and risk management rules.

GET/v1/analysis/:token

Get detailed order flow analysis for a specific token pair.

POST/v1/trades/execute

Execute a trade with predefined parameters and risk controls.

Integration Guide

Basic Connection

import { CerulonClient } from '@cerulon/client'

const client = new CerulonClient({
  apiKey: process.env.CERULON_API_KEY,
  network: 'mainnet-beta'
})

// Get market analysis
const analysis = await client.getAnalysis('SOL/USDC')
console.log(analysis.liquidityScore) // 0-100

Signal Subscription

// Subscribe to trading signals
const stream = client.subscribeToSignals({
  markets: ['SOL/USDC', 'RAY/USDC'],
  minConfidence: 75
})

stream.on('signal', (signal) => {
  console.log('Opportunity detected:', signal.type)
  console.log('Confidence:', signal.confidence)
  console.log('Suggested entry:', signal.entry)
})

stream.on('error', (err) => {
  console.error('Stream error:', err)
})

Developer Notes

Rate Limits

Free tier: 50 signals/day. Premium tier: Unlimited signals + automated execution. Enterprise: Custom deployment with dedicated infrastructure.

Risk Management

All trades execute with mandatory stop losses. Client SDK enforces position limits locally. Override protection with riskOverride: true (not recommended).

Performance Tracking

Every signal includes historical win rate and average P&L. Track your execution performance against signal recommendations. Never trade with capital you cannot afford to lose.