Developers

API Reference

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

Pattern Search & Analytics

GET/api/patterns

Basic Pattern Search

Returns query window data, per-match telemetry, and percentile forecasts.

Example Request

curl -s -G "$BASE_URL/api/patterns" \
--data-urlencode "symbol=BTCUSDT" \
--data-urlencode "interval=1h" \
--data-urlencode "q=60" \
--data-urlencode "f=30" \
--data-urlencode "limit=20" | jq

GET/api/patterns/metrics

Pattern Metrics

Produces a full statistical digest for the current query window. Reuses the same analogue cohort as /api/patterns but skips raw series data.

Example Request

curl -s -G "$BASE_URL/api/patterns/metrics" \
--data-urlencode "symbol=BTCUSDT" \
--data-urlencode "interval=1h" | jq

GET/api/patterns/grid

Grid Trading Stats

Provides grid-trading guidance (sigma levels, terminal percentiles, price zone, recommendation, and confidence score).

Example Request

curl -s -G "$BASE_URL/api/patterns/grid" \
--data-urlencode "symbol=BTCUSDT" \
--data-urlencode "interval=1h" | jq

POST/api/patterns/batch

Batch Search

Run multiple searches in a single request.

Example Request

curl -s -X POST "$BASE_URL/api/patterns/batch" \
-H "Content-Type: application/json" \
-d "{
    \"requests\": [
      { \"symbol\": \"BTCUSDT\", \"interval\": \"1h\", \"q\": 60, \"f\": 30, \"limit\": 16 },
      { \"symbol\": \"ETHUSDT\", \"interval\": \"4h\", \"q\": 80, \"f\": 40 }
    ]
  }" | jq