Skip to main content
GET
/
vq
/
screener
Run stock screener
curl --request GET \
  --url https://api.vectrade.io/v1/vq/screener \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "symbol": "<string>",
      "companyName": "<string>",
      "price": 123,
      "changePct": 123,
      "marketCap": 123,
      "peRatio": 123,
      "dividendYield": 123,
      "sector": "<string>",
      "industry": "<string>",
      "volume": 123,
      "rsi14": 123
    }
  ],
  "page_info": {
    "hasNext": true,
    "cursor": "<string>",
    "totalCount": 123
  }
}

Authorizations

X-API-Key
string
header
required

VecTrade API key (e.g., vq_live_...)

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

dividend_yield_min
number

Minimum dividend yield

sector
string

Filter by sector

industry
string

Filter by industry

country
string
default:US

Country code filter

sort_by
enum<string>
default:market_cap

Sort field

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

Sort direction

Available options:
asc,
desc
volume_min
integer

Minimum trading volume

exchange
enum<string>

Exchange filter

Available options:
NYSE,
NASDAQ,
AMEX
cursor
string

Pagination cursor

limit
integer
default:50

Results per page

Required range: x <= 200

Response

Screener results (paginated)

data
object[]
page_info
object