Screeners

Screeners run ready-made filters on a set of symbols and return the ones that meet the filter’s conditions.

The order to follow

1. Call Configuration and pick a screener.
2. Read that screener’s entry to see what it accepts.
3. Call the Standard, Candlestick or Technical API with the screener’s id.

Before you start

• You need your App ID and an access token (see the Authentication page of these docs). On every call, send them in the Authorization header as APP_ID:ACCESS_TOKEN.
• Every Screeners API is a GET call. Parameters go in the URL query string, for example ?screener_id=top_gainers&fields=t0_close_ltp.
• Terms used on these pages: a screener is a ready-made filter; a universe is the set of symbols it scans (for example Nifty 50); a timeframe is the period over which a change is measured; a field is one column of the result.

Your first call, in three steps

1. Call Configuration and note a screener id from screeners_standard, for example top_gainers.
2. Call Standard screeners with screener_id=top_gainers&fields=t0_close_ltp.
3. Read the result: header names the columns (symbolticker, then t0_close_ltp) and each array in body is one stock, in that order.