Remora Risk Engine

🔌 API Documentation

Interactive API Documentation

Home Integrations Evidence & Backtesting Service Status API Documentation How Remora Works Sign Up

Interactive API Documentation

For interactive API documentation with request/response examples, see our Swagger UI and ReDoc:

📚 Open Swagger UI 📖 Open ReDoc

⚡ Get Started in 30 Seconds

Step 1: Get API Key

Sign up and get you free API key, instantly.

No credit card/details required.

Sign Up Free

Step 2: Test with curl

Test the API with your new API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \ "https://remora-ai.com/api/v1/risk?pair=BTC/USDT"

Step 3: Integrate

Add one function to your Freqtrade strategy - done!

Your bot is now protected from bad trades detected by Remora Risk Engine.

View Integration Examples

API Endpoints

GET /api/health
Health check endpoint. Returns service status and version information.
https://remora-ai.com/api/health
GET /api/v1/risk
Get comprehensive risk assessment for a trading pair or market-wide assessment.

Query Parameters:

pair (optional, string)
Trading pair in format "SYMBOL/QUOTE" (e.g., "SOL/USD", "BTC/USDT"). If omitted, returns market-wide risk assessment.
https://remora-ai.com/api/v1/risk?pair=SOL/USD
Returns: RiskResponse with risk_score, regime, volatility, safe_to_trade, recommendation, reasoning, indicators, and external metrics including:
  • Fear & Greed Index
  • BTC Dominance & Funding Rate
  • Open Interest (contracts, USD value, 24h change)
  • Liquidations (total, long, short, ratio)
  • VIX & DXY (traditional market indicators)
  • News Sentiment
GET /api/v1/regime
Get market regime classification only (Bull, Bear, Choppy, Volatile, etc.).

Query Parameters:

pair (optional, string)
Trading pair (e.g., "SOL/USD"). If omitted, returns market-wide regime.
https://remora-ai.com/api/v1/regime?pair=SOL/USD
GET /api/v1/volatility
Get volatility analysis and classification for a trading pair.

Query Parameters:

pair (optional, string)
Trading pair (e.g., "SOL/USD"). If omitted, returns market-wide volatility.
https://remora-ai.com/api/v1/volatility?pair=SOL/USD
GET /api/v1/context
Alias for /api/v1/risk. Returns the same comprehensive risk assessment.

Query Parameters:

pair (optional, string)
Trading pair (e.g., "SOL/USD").
https://remora-ai.com/api/v1/context?pair=SOL/USD
GET /api/v1/sentiment
Get sentiment data for a specific trading pair. Designed for CSV compatibility.

Query Parameters:

pair (required, string)
Trading pair (e.g., "SOL/USD"). This parameter is required.
https://remora-ai.com/api/v1/sentiment?pair=SOL/USD

Response Format

All endpoints return JSON responses. The main risk assessment endpoint includes:

  • risk_score: Composite risk score (0-1, where 0 is low risk, 1 is high risk)
  • regime: Market regime classification (bull, bear, choppy, high_vol, panic, sideways)
  • volatility: Volatility score and classification
  • safe_to_trade: Boolean indicating if trading is currently safe
  • recommendation: Trading recommendation
  • reasoning: Array of human-readable reasons
  • indicators: Detailed technical indicators
  • external: External data (Fear & Greed, BTC Dominance, Funding Rate, Open Interest, Liquidations, VIX, DXY, News Sentiment)

Authentication

Most endpoints are publicly accessible.

For API key-based access control, please sign up to get your API key.

Get API Key