Developers

API Reference

Comprehensive documentation for the rlx-search HTTP API. Manage datasets, compute pattern matches, run ANN searches, and train RL agents.

Backtesting

Simulate historical performance of the pattern matching engine to validate predictive power. The system walks forward through history, performing a search at each step using only data available at that time.

GET/api/patterns/backtest

Run Simulation

Runs a backtest simulation over a time range.

Example Request

curl -s -G "$BASE_URL/api/patterns/backtest" \
--data-urlencode "symbol=BTCUSDT" \
--data-urlencode "interval=1h" \
--data-urlencode "q=24" \
--data-urlencode "f=12" \
--data-urlencode "step=24" \
--data-urlencode "topK=5" | jq

POST/api/patterns/backtest/specific

Specific Pattern Backtest

Runs a backtest for a specific pattern configuration with fees and slippage.

Example Request

curl -s -X POST "$BASE_URL/api/patterns/backtest/specific" \
-H "Content-Type: application/json" \
-d "{
\"symbol\": \"BTCUSDT\",
\"interval\": \"1h\",
\"q\": 24,
\"f\": 12,
\"feePct\": 0.04,
\"slippagePct\": 0.02,
\"includeStats\": true,
\"timestamp\": 1710000000000
}" | jq