Technical Indicator - Surf API Documentation

{ "data": [ { "interval": "<string>", "name": "<string>", "symbol": "<string>", "value": 123, "timestamp": 123, "updated_at": 123, "values": { "bbands_lower": 123, "bbands_middle": 123, "bbands_upper": 123, "dmi_adx": 123, "dmi_mdi": 123, "dmi_pdi": 123, "ichimoku_base": 123, "ichimoku_conversion": 123, "ichimoku_current_span_a": 123, "ichimoku_current_span_b": 123, "ichimoku_lagging_span_a": 123, "ichimoku_lagging_span_b": 123, "ichimoku_span_a": 123, "ichimoku_span_b": 123, "macd_hist": 123, "macd_signal": 123, "macd_value": 123, "stoch_d": 123, "stoch_k": 123, "supertrend_advice": "<string>", "supertrend_value": 123 } } ], "meta": { "cached": true, "credits_used": 123 }, "$schema": "<string>" }

Query Parameters

indicator

enum<string>

required

Technical indicator name. Can be rsi, macd, ema, sma, bbands, stoch, adx, atr, cci, obv, vwap, dmi, ichimoku, or supertrend.

Available options:

rsi,

macd,

ema,

sma,

bbands,

stoch,

adx,

atr,

cci,

obv,

vwap,

dmi,

ichimoku,

supertrend

Example:

"rsi"

symbol

string

required

Trading pair as BTC/USDT or bare symbol like BTC

Example:

"BTC"

interval

enum<string>

default:1d

Candlestick interval. Can be 1m, 5m, 15m, 30m, 1h, 2h, 4h, 12h, 1d, or 1w.

Available options:

1m,

5m,

15m,

30m,

1h,

2h,

4h,

12h,

1d,

1w

Example:

"1d"

exchange

enum<string>

default:binance

Exchange for price data. Can be binance, bybit, coinbase, or kraken.

Available options:

binance,

bybit,

coinbase,

kraken

Example:

"binance"

from

string

Start of time range. When set, returns time-series instead of latest value. Accepts Unix seconds (1704067200) or date string (2024-01-01)

Example:

"2024-01-01"

string

End of time range. Defaults to now when from is set. Accepts Unix seconds (1706745600) or date string (2024-02-01)

Example:

"2024-02-01"

options

string

Indicator-specific options as comma-separated key:value pairs. Available options by indicator: period — lookback period for rsi (default 14), sma (default 20), ema (default 20), bbands (default 20), adx (default 14), atr (default 14), cci (default 20), dmi (default 14), stoch (default 14), supertrend (default 10). stddev — standard deviation for bbands (default 2). multiplier — multiplier for supertrend (default 3). fast_period — MACD fast EMA (default 12). slow_period — MACD slow EMA (default 26). signal_period — MACD signal smoothing (default 9). Examples: period:7, period:200, fast_period:8,slow_period:21,signal_period:5, period:10,stddev:1.5.

Example:

"period:7"

Response

data

object[] | null

required

Show child attributes

API Reference

Query Parameters

Response