Screen stocks by fundamental metrics
curl --request POST \
--url https://api.example.com/api/graph/v1/research/screener \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"sector": [
"<string>"
],
"market_cap": {
"min": 123,
"max": 123
},
"pe_ratio": {
"min": 123,
"max": 123
},
"pb_ratio": {
"min": 123,
"max": 123
},
"ps_ratio": {
"min": 123,
"max": 123
},
"ev_ebitda": {
"min": 123,
"max": 123
},
"gross_margin": {
"min": 123,
"max": 123
},
"operating_margin": {
"min": 123,
"max": 123
},
"net_margin": {
"min": 123,
"max": 123
},
"roe": {
"min": 123,
"max": 123
},
"roa": {
"min": 123,
"max": 123
},
"debt_to_equity": {
"min": 123,
"max": 123
},
"current_ratio": {
"min": 123,
"max": 123
},
"dividend_yield": {
"min": 123,
"max": 123
},
"fcf_yield": {
"min": 123,
"max": 123
},
"earnings_yield": {
"min": 123,
"max": 123
}
},
"sort": {
"field": "marketCap",
"order": "desc"
},
"pagination": {
"limit": 50,
"offset": 0
}
}
'import requests
url = "https://api.example.com/api/graph/v1/research/screener"
payload = {
"filters": {
"sector": ["<string>"],
"market_cap": {
"min": 123,
"max": 123
},
"pe_ratio": {
"min": 123,
"max": 123
},
"pb_ratio": {
"min": 123,
"max": 123
},
"ps_ratio": {
"min": 123,
"max": 123
},
"ev_ebitda": {
"min": 123,
"max": 123
},
"gross_margin": {
"min": 123,
"max": 123
},
"operating_margin": {
"min": 123,
"max": 123
},
"net_margin": {
"min": 123,
"max": 123
},
"roe": {
"min": 123,
"max": 123
},
"roa": {
"min": 123,
"max": 123
},
"debt_to_equity": {
"min": 123,
"max": 123
},
"current_ratio": {
"min": 123,
"max": 123
},
"dividend_yield": {
"min": 123,
"max": 123
},
"fcf_yield": {
"min": 123,
"max": 123
},
"earnings_yield": {
"min": 123,
"max": 123
}
},
"sort": {
"field": "marketCap",
"order": "desc"
},
"pagination": {
"limit": 50,
"offset": 0
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
sector: ['<string>'],
market_cap: {min: 123, max: 123},
pe_ratio: {min: 123, max: 123},
pb_ratio: {min: 123, max: 123},
ps_ratio: {min: 123, max: 123},
ev_ebitda: {min: 123, max: 123},
gross_margin: {min: 123, max: 123},
operating_margin: {min: 123, max: 123},
net_margin: {min: 123, max: 123},
roe: {min: 123, max: 123},
roa: {min: 123, max: 123},
debt_to_equity: {min: 123, max: 123},
current_ratio: {min: 123, max: 123},
dividend_yield: {min: 123, max: 123},
fcf_yield: {min: 123, max: 123},
earnings_yield: {min: 123, max: 123}
},
sort: {field: 'marketCap', order: 'desc'},
pagination: {limit: 50, offset: 0}
})
};
fetch('https://api.example.com/api/graph/v1/research/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.example.com/api/graph/v1/research/screener",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'sector' => [
'<string>'
],
'market_cap' => [
'min' => 123,
'max' => 123
],
'pe_ratio' => [
'min' => 123,
'max' => 123
],
'pb_ratio' => [
'min' => 123,
'max' => 123
],
'ps_ratio' => [
'min' => 123,
'max' => 123
],
'ev_ebitda' => [
'min' => 123,
'max' => 123
],
'gross_margin' => [
'min' => 123,
'max' => 123
],
'operating_margin' => [
'min' => 123,
'max' => 123
],
'net_margin' => [
'min' => 123,
'max' => 123
],
'roe' => [
'min' => 123,
'max' => 123
],
'roa' => [
'min' => 123,
'max' => 123
],
'debt_to_equity' => [
'min' => 123,
'max' => 123
],
'current_ratio' => [
'min' => 123,
'max' => 123
],
'dividend_yield' => [
'min' => 123,
'max' => 123
],
'fcf_yield' => [
'min' => 123,
'max' => 123
],
'earnings_yield' => [
'min' => 123,
'max' => 123
]
],
'sort' => [
'field' => 'marketCap',
'order' => 'desc'
],
'pagination' => [
'limit' => 50,
'offset' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/graph/v1/research/screener"
payload := strings.NewReader("{\n \"filters\": {\n \"sector\": [\n \"<string>\"\n ],\n \"market_cap\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pe_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pb_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ps_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ev_ebitda\": {\n \"min\": 123,\n \"max\": 123\n },\n \"gross_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"operating_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"net_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roe\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roa\": {\n \"min\": 123,\n \"max\": 123\n },\n \"debt_to_equity\": {\n \"min\": 123,\n \"max\": 123\n },\n \"current_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"dividend_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"fcf_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"earnings_yield\": {\n \"min\": 123,\n \"max\": 123\n }\n },\n \"sort\": {\n \"field\": \"marketCap\",\n \"order\": \"desc\"\n },\n \"pagination\": {\n \"limit\": 50,\n \"offset\": 0\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/graph/v1/research/screener")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"sector\": [\n \"<string>\"\n ],\n \"market_cap\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pe_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pb_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ps_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ev_ebitda\": {\n \"min\": 123,\n \"max\": 123\n },\n \"gross_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"operating_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"net_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roe\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roa\": {\n \"min\": 123,\n \"max\": 123\n },\n \"debt_to_equity\": {\n \"min\": 123,\n \"max\": 123\n },\n \"current_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"dividend_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"fcf_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"earnings_yield\": {\n \"min\": 123,\n \"max\": 123\n }\n },\n \"sort\": {\n \"field\": \"marketCap\",\n \"order\": \"desc\"\n },\n \"pagination\": {\n \"limit\": 50,\n \"offset\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/graph/v1/research/screener")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"sector\": [\n \"<string>\"\n ],\n \"market_cap\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pe_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pb_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ps_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ev_ebitda\": {\n \"min\": 123,\n \"max\": 123\n },\n \"gross_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"operating_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"net_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roe\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roa\": {\n \"min\": 123,\n \"max\": 123\n },\n \"debt_to_equity\": {\n \"min\": 123,\n \"max\": 123\n },\n \"current_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"dividend_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"fcf_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"earnings_yield\": {\n \"min\": 123,\n \"max\": 123\n }\n },\n \"sort\": {\n \"field\": \"marketCap\",\n \"order\": \"desc\"\n },\n \"pagination\": {\n \"limit\": 50,\n \"offset\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"symbol": "<string>",
"metrics": {},
"company_name": "<string>",
"sector": "<string>",
"industry": "<string>"
}
],
"total_matched": 123,
"returned": 123,
"offset": 123,
"query_ms": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Research
Screen stocks by fundamental metrics
Filter and sort stocks using fundamental financial metrics.
POST
/
api
/
graph
/
v1
/
research
/
screener
Screen stocks by fundamental metrics
curl --request POST \
--url https://api.example.com/api/graph/v1/research/screener \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"sector": [
"<string>"
],
"market_cap": {
"min": 123,
"max": 123
},
"pe_ratio": {
"min": 123,
"max": 123
},
"pb_ratio": {
"min": 123,
"max": 123
},
"ps_ratio": {
"min": 123,
"max": 123
},
"ev_ebitda": {
"min": 123,
"max": 123
},
"gross_margin": {
"min": 123,
"max": 123
},
"operating_margin": {
"min": 123,
"max": 123
},
"net_margin": {
"min": 123,
"max": 123
},
"roe": {
"min": 123,
"max": 123
},
"roa": {
"min": 123,
"max": 123
},
"debt_to_equity": {
"min": 123,
"max": 123
},
"current_ratio": {
"min": 123,
"max": 123
},
"dividend_yield": {
"min": 123,
"max": 123
},
"fcf_yield": {
"min": 123,
"max": 123
},
"earnings_yield": {
"min": 123,
"max": 123
}
},
"sort": {
"field": "marketCap",
"order": "desc"
},
"pagination": {
"limit": 50,
"offset": 0
}
}
'import requests
url = "https://api.example.com/api/graph/v1/research/screener"
payload = {
"filters": {
"sector": ["<string>"],
"market_cap": {
"min": 123,
"max": 123
},
"pe_ratio": {
"min": 123,
"max": 123
},
"pb_ratio": {
"min": 123,
"max": 123
},
"ps_ratio": {
"min": 123,
"max": 123
},
"ev_ebitda": {
"min": 123,
"max": 123
},
"gross_margin": {
"min": 123,
"max": 123
},
"operating_margin": {
"min": 123,
"max": 123
},
"net_margin": {
"min": 123,
"max": 123
},
"roe": {
"min": 123,
"max": 123
},
"roa": {
"min": 123,
"max": 123
},
"debt_to_equity": {
"min": 123,
"max": 123
},
"current_ratio": {
"min": 123,
"max": 123
},
"dividend_yield": {
"min": 123,
"max": 123
},
"fcf_yield": {
"min": 123,
"max": 123
},
"earnings_yield": {
"min": 123,
"max": 123
}
},
"sort": {
"field": "marketCap",
"order": "desc"
},
"pagination": {
"limit": 50,
"offset": 0
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
sector: ['<string>'],
market_cap: {min: 123, max: 123},
pe_ratio: {min: 123, max: 123},
pb_ratio: {min: 123, max: 123},
ps_ratio: {min: 123, max: 123},
ev_ebitda: {min: 123, max: 123},
gross_margin: {min: 123, max: 123},
operating_margin: {min: 123, max: 123},
net_margin: {min: 123, max: 123},
roe: {min: 123, max: 123},
roa: {min: 123, max: 123},
debt_to_equity: {min: 123, max: 123},
current_ratio: {min: 123, max: 123},
dividend_yield: {min: 123, max: 123},
fcf_yield: {min: 123, max: 123},
earnings_yield: {min: 123, max: 123}
},
sort: {field: 'marketCap', order: 'desc'},
pagination: {limit: 50, offset: 0}
})
};
fetch('https://api.example.com/api/graph/v1/research/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.example.com/api/graph/v1/research/screener",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'sector' => [
'<string>'
],
'market_cap' => [
'min' => 123,
'max' => 123
],
'pe_ratio' => [
'min' => 123,
'max' => 123
],
'pb_ratio' => [
'min' => 123,
'max' => 123
],
'ps_ratio' => [
'min' => 123,
'max' => 123
],
'ev_ebitda' => [
'min' => 123,
'max' => 123
],
'gross_margin' => [
'min' => 123,
'max' => 123
],
'operating_margin' => [
'min' => 123,
'max' => 123
],
'net_margin' => [
'min' => 123,
'max' => 123
],
'roe' => [
'min' => 123,
'max' => 123
],
'roa' => [
'min' => 123,
'max' => 123
],
'debt_to_equity' => [
'min' => 123,
'max' => 123
],
'current_ratio' => [
'min' => 123,
'max' => 123
],
'dividend_yield' => [
'min' => 123,
'max' => 123
],
'fcf_yield' => [
'min' => 123,
'max' => 123
],
'earnings_yield' => [
'min' => 123,
'max' => 123
]
],
'sort' => [
'field' => 'marketCap',
'order' => 'desc'
],
'pagination' => [
'limit' => 50,
'offset' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/graph/v1/research/screener"
payload := strings.NewReader("{\n \"filters\": {\n \"sector\": [\n \"<string>\"\n ],\n \"market_cap\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pe_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pb_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ps_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ev_ebitda\": {\n \"min\": 123,\n \"max\": 123\n },\n \"gross_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"operating_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"net_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roe\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roa\": {\n \"min\": 123,\n \"max\": 123\n },\n \"debt_to_equity\": {\n \"min\": 123,\n \"max\": 123\n },\n \"current_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"dividend_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"fcf_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"earnings_yield\": {\n \"min\": 123,\n \"max\": 123\n }\n },\n \"sort\": {\n \"field\": \"marketCap\",\n \"order\": \"desc\"\n },\n \"pagination\": {\n \"limit\": 50,\n \"offset\": 0\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/graph/v1/research/screener")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"sector\": [\n \"<string>\"\n ],\n \"market_cap\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pe_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pb_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ps_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ev_ebitda\": {\n \"min\": 123,\n \"max\": 123\n },\n \"gross_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"operating_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"net_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roe\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roa\": {\n \"min\": 123,\n \"max\": 123\n },\n \"debt_to_equity\": {\n \"min\": 123,\n \"max\": 123\n },\n \"current_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"dividend_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"fcf_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"earnings_yield\": {\n \"min\": 123,\n \"max\": 123\n }\n },\n \"sort\": {\n \"field\": \"marketCap\",\n \"order\": \"desc\"\n },\n \"pagination\": {\n \"limit\": 50,\n \"offset\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/graph/v1/research/screener")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"sector\": [\n \"<string>\"\n ],\n \"market_cap\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pe_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"pb_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ps_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"ev_ebitda\": {\n \"min\": 123,\n \"max\": 123\n },\n \"gross_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"operating_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"net_margin\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roe\": {\n \"min\": 123,\n \"max\": 123\n },\n \"roa\": {\n \"min\": 123,\n \"max\": 123\n },\n \"debt_to_equity\": {\n \"min\": 123,\n \"max\": 123\n },\n \"current_ratio\": {\n \"min\": 123,\n \"max\": 123\n },\n \"dividend_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"fcf_yield\": {\n \"min\": 123,\n \"max\": 123\n },\n \"earnings_yield\": {\n \"min\": 123,\n \"max\": 123\n }\n },\n \"sort\": {\n \"field\": \"marketCap\",\n \"order\": \"desc\"\n },\n \"pagination\": {\n \"limit\": 50,\n \"offset\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"symbol": "<string>",
"metrics": {},
"company_name": "<string>",
"sector": "<string>",
"industry": "<string>"
}
],
"total_matched": 123,
"returned": 123,
"offset": 123,
"query_ms": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json