Skip to main content

Pagination

The VQ stock screener is currently the SDK resource that supports cursor pagination. News, quotes, and other resource methods return their documented response directly; they do not expose the screener cursor interface.

Screener Response

GET /v1/vq/screener returns a status envelope, one page of results, and pagination metadata:
page_info.has_next indicates whether another page exists. Pass page_info.cursor as the next request’s cursor. Treat the cursor as an API value; the endpoint does not return a total result count.

Python

The synchronous and asynchronous clients fetch subsequent pages as you iterate:
For synchronous code that needs page boundaries, use .pages(); each page provides .data and .page_info:

TypeScript

The Node SDK exposes an async iterator. It also provides .pages() for page-by-page arrays, .take(count) to stop early, and .toArray() to collect all results.

REST API

Send your API key in the X-API-Key header. The limit defaults to 20 and must be between 1 and 50.
Use the returned cursor to request the next page:

Supported Filters

The endpoint supports 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, volume_min, and sector. sort_by accepts market_cap, pe_ratio, dividend_yield, volume, change_pct, rsi_14, beta, or revenue_growth_yoy. sort_order accepts asc or desc. The service screens its configured market universe. An accepted filter or sort field does not guarantee every instrument has a value for that metric; missing metrics may not match numeric filters. With a limit below the universe size, results are sorted within each cursor page. The current default universe contains 50 symbols, so limit=50 returns one globally sorted page for that configuration.