Run a screener (params in JSON body)

The only endpoint on this API that takes parameters in a JSON request body rather than a query string. Screener ids include bullish-pullback, momentum, volatility-squeeze, small-cap, volatility-surge, gamma-scan, csp-wheel, leaps, leveraged, daily-cuts, accumulation-watch, stage2-uptrend and momentum-leaders. stage2-uptrend and momentum-leaders: membership list only on the public API (symbol, name, direction, earningsSoon; no prices or market data).

post/screeners/{id}/run

Request

  • Base URL: https://api.tradermatrix.pro/api/v1
  • URL: https://api.tradermatrix.pro/api/v1/screeners/{id}/run
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring required

Request body

object required

Screener-specific params — see GET /screeners/{id} for the param list.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.