Run stock screener
curl --request GET \
--url https://api.vectrade.io/v1/vq/screener \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vectrade.io/v1/vq/screener"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.vectrade.io/v1/vq/screener', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vectrade.io/v1/vq/screener",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vectrade.io/v1/vq/screener"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vectrade.io/v1/vq/screener")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vectrade.io/v1/vq/screener")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "ok",
"data": [
{
"symbol": "<string>",
"companyName": "<string>",
"price": 123,
"changePct": 123,
"marketCap": 123,
"peRatio": 123,
"dividendYield": 123,
"beta": 123,
"revenueGrowthYoy": 123,
"sector": "<string>",
"volume": 123,
"rsi14": 123
}
],
"page_info": {
"has_next": true,
"cursor": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"docs_url": "<string>"
},
"request_id": "<string>"
}{
"error": {
"message": "<string>",
"type": "<string>",
"docs_url": "<string>"
},
"request_id": "<string>"
}{
"error": {
"message": "<string>",
"type": "<string>",
"docs_url": "<string>"
},
"request_id": "<string>"
}Market Data
Run Screener
Run a market screener with fundamental, technical, and price filters across supported instruments.
GET
/
vq
/
screener
Run stock screener
curl --request GET \
--url https://api.vectrade.io/v1/vq/screener \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vectrade.io/v1/vq/screener"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.vectrade.io/v1/vq/screener', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vectrade.io/v1/vq/screener",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vectrade.io/v1/vq/screener"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vectrade.io/v1/vq/screener")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vectrade.io/v1/vq/screener")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "ok",
"data": [
{
"symbol": "<string>",
"companyName": "<string>",
"price": 123,
"changePct": 123,
"marketCap": 123,
"peRatio": 123,
"dividendYield": 123,
"beta": 123,
"revenueGrowthYoy": 123,
"sector": "<string>",
"volume": 123,
"rsi14": 123
}
],
"page_info": {
"has_next": true,
"cursor": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"docs_url": "<string>"
},
"request_id": "<string>"
}{
"error": {
"message": "<string>",
"type": "<string>",
"docs_url": "<string>"
},
"request_id": "<string>"
}{
"error": {
"message": "<string>",
"type": "<string>",
"docs_url": "<string>"
},
"request_id": "<string>"
}The endpoint returns
Python and TypeScript SDKs expose this endpoint as an auto-paginating iterator. See the pagination guide for examples.
{ 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.
curl -G "https://api.vectrade.io/v1/vq/screener" \
-H "X-API-Key: $VECTRADE_API_KEY" \
--data-urlencode "market_cap_min=10000000000" \
--data-urlencode "pe_max=20" \
--data-urlencode "sector=Technology" \
--data-urlencode "limit=50"