Technical analysis and sizing

get_indicatorCopy Anchor Link

Compute one of 16 indicators (RSI, MACD, ATR, SMA, EMA, BOLLINGER, ADX, STOCHASTIC, CCI, PARABOLIC_SAR, ICHIMOKU, WPR, MFI, STDDEV, DEMARKER, MOMENTUM) server-side from closed bars. order:"newest_first": values[0] is the latest CLOSED bar and equals current. Raw numbers only (no signals). Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_indicator

Example request:

{
  "symbol": "BTC/USDT:USDT",
  "timeframe": "M1",
  "indicator": "<indicator>"
}

check_confluenceCopy Anchor Link

Evaluate up to 10 indicator/price conditions on the latest closed bar (cross_above/cross_below use the previous bar). Returns per-condition booleans (met:null when an input is unavailable — never guessed) and counts; no buy/sell verdict. Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/check_confluence

Example request:

{
  "symbol": "BTC/USDT:USDT",
  "timeframe": "M1",
  "conditions": []
}

get_key_levelsCopy Anchor Link

Support/resistance candidates: classic pivots from the previous completed bar of pivot_timeframe, recent fractal swing highs/lows, the lookback high/low, and psychological round numbers scaled to the price magnitude (step echoed in criteria). Raw levels, nearest first within ±10% of price. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_key_levels

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_fibonacci_levelsCopy Anchor Link

Fibonacci retracement/extension levels between the most recent swing high and swing low in the lookback (or an explicit high/low). direction "up" means the move went low→high (levels retrace down from the high) and uses a swing low that came before its swing high; "down" the reverse. Without a direction the most recent swing ends the leg; when no swing pair fits, insufficient_history is returned. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_fibonacci_levels

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

detect_patternsCopy Anchor Link

Candlestick patterns (doji, hammer, bullish/bearish engulfing) over the last N closed bars, order:"chronological", each with bar_time. Raw detections; no direction advice. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/detect_patterns

Example request:

{
  "symbol": "BTC/USDT:USDT",
  "timeframe": "M1"
}

detect_structureCopy Anchor Link

Smart-money structures over closed bars: fair-value gaps, order blocks, liquidity sweeps, BOS and CHoCH with fixed criteria echoed in the response. order:"chronological". Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/detect_structure

Example request:

{
  "symbol": "BTC/USDT:USDT",
  "timeframe": "M1"
}

get_market_structureCopy Anchor Link

Multi-timeframe HH/HL/LH/LL swing sequence, trend (uptrend/downtrend/range) and BOS/CHoCH events per timeframe, plus whether the trends are aligned. Close-based confirmation; criteria echoed. Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/get_market_structure

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_volatility_regimeCopy Anchor Link

Classify volatility as compressed/expanding/trending/choppy from ATR ratio, Bollinger-bandwidth percentile and Kaufman efficiency ratio (fixed thresholds echoed). Also returns er and, with include_adx, adx_h4/adx_d1 so label-vs-ER overrides need no extra calls. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_volatility_regime

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_correlation_matrixCopy Anchor Link

Pairwise correlation (symbols default to the connection's trade universe, up to 20; scope:"exchange_top" uses the top USDT markets of the connection's market type by volume) of log returns (method "returns") or closes aligned by bar time, with single-linkage clusters above cluster_threshold. residual_vs:"BTC" first removes each asset's BTC beta (crypto is one-factor dominated: raw alt correlations are all high) and reports beta_to_btc. NaN cells (insufficient overlap) are returned as null. Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/get_correlation_matrix

Example request:

{}

calculate_position_sizeCopy Anchor Link

Size a position from a stop distance and a risk budget (risk_usdt, or risk_percent of account equity). Uses the single sizing function shared with CHECK_ORDER. Returns size_usdt (what to pass to place_order), amount_base, contracts, actual risk, min-notional check, rounding loss, required margin and estimated liquidation vs the stop, and max_leverage_for_stop (the highest leverage that keeps liquidation ≥ 1.5× the stop distance beyond the stop, ≈ 1 / (1.5 × stop_distance_pct + mmr)). Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/calculate_position_size

Example request:

{
  "symbol": "BTC/USDT:USDT",
  "stop_price": 0
}

estimate_fillCopy Anchor Link

Estimate a market order's fill by walking the live order book for size_usdt: average price, slippage vs mid in bps, levels consumed, taker fee and total cost. Basis is "book_walk" (no queue position, no latency). Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/estimate_fill

Example request:

{
  "symbol": "BTC/USDT:USDT",
  "side": "buy",
  "size_usdt": 0
}