Remora Risk Engine
API Documentation
API Documentation
For interactive API documentation with request/response examples, see our Swagger UI:
Main Endpoint: Get Risk Assessment
This is the endpoint you'll use in your Freqtrade strategy. It returns a risk assessment with a safe_to_trade boolean and full reasoning.
Designed for low-latency, synchronous use in trading bots. Requests time out safely on client side.
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., "BTC/USDT", "SOL/USD"). If omitted, Remora returns a market-wide risk assessment useful for global trade gating.
Trading pair in format "SYMBOL/QUOTE" (e.g., "BTC/USDT", "SOL/USD"). If omitted, Remora returns a market-wide risk assessment useful for global trade gating.
Response Format
The API returns JSON with these key fields:
- safe_to_trade: Boolean - true if conditions are safe, false if risky
- risk_score: Number (0-1) - composite risk score where 0 is low risk, 1 is high risk
- regime: String - market regime (bull, bear, choppy, volatile, etc.)
- reasoning: Array - human-readable explanations for the decision
- recommendation: String - trading recommendation (entry_ok, no_entry, caution)
- volatility: Number - volatility score and classification
- external: Object - external data (Fear & Greed, BTC Dominance, Funding Rate, etc.)
For full response schema, see the Swagger UI.
Quick Start Example
Test the API with curl:
curl "https://remora-ai.com/api/v1/risk?pair=BTC/USDT"
With API key (optional, for higher rate limits):
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://remora-ai.com/api/v1/risk?pair=BTC/USDT"
Authentication
The API is publicly accessible without authentication. However, API keys provide higher rate limits and priority access.