Skip to main content
GET
Run stock screener
The endpoint returns { status, data, page_info }. page_info.has_next indicates whether another page exists; pass page_info.cursor back as the cursor query parameter. The default limit is 20 and the allowed range is 1–50. Supported numeric filters are market_cap_min, market_cap_max, pe_min, pe_max, change_min, change_max, dividend_yield_min, dividend_yield_max, beta_min, beta_max, revenue_growth_min, revenue_growth_max, rsi_min, rsi_max, and volume_min. The only categorical filter is sector. Supported sort fields are market_cap, pe_ratio, dividend_yield, volume, change_pct, rsi_14, beta, and revenue_growth_yoy. Sort order is asc or desc.
Python and TypeScript SDKs expose this endpoint as an auto-paginating iterator. See the pagination guide for examples.

Authorizations

X-API-Key
string
header
required

VecTrade VQ API key (vq_...)

Query Parameters

market_cap_min
number

Minimum market capitalization

market_cap_max
number

Maximum market capitalization

pe_min
number

Minimum P/E ratio

pe_max
number

Maximum P/E ratio

change_min
number

Minimum percentage price change

change_max
number

Maximum percentage price change

dividend_yield_min
number

Minimum dividend yield

dividend_yield_max
number

Maximum dividend yield

beta_min
number

Minimum beta

beta_max
number

Maximum beta

revenue_growth_min
number

Minimum year-over-year revenue growth percentage

revenue_growth_max
number

Maximum year-over-year revenue growth percentage

rsi_min
number

Minimum 14-period RSI

rsi_max
number

Maximum 14-period RSI

sector
string

Filter by sector

sort_by
enum<string>
default:market_cap

Sort field

Available options:
market_cap,
pe_ratio,
dividend_yield,
volume,
change_pct,
rsi_14,
beta,
revenue_growth_yoy
sort_order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
volume_min
integer

Minimum trading volume

cursor
string

Pagination cursor

limit
integer
default:20

Results per page

Required range: 1 <= x <= 50

Response

Screener results (paginated)

status
enum<string>
required
Available options:
ok
data
object[]
required
page_info
object
required