Skip to main content
POST
/
v1
/
company-screener
/
query
Stocks & Funds Screener
curl --request POST \
  --url https://api.bigdata.com/v1/company-screener/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "filters": {
    "is_actively_trading": true,
    "market_cap_more_than": 1000000000,
    "price_more_than": 10,
    "sector": "Technology"
  },
  "limit": 100
}
'
import requests

url = "https://api.bigdata.com/v1/company-screener/query"

payload = {
"filters": {
"is_actively_trading": True,
"market_cap_more_than": 1000000000,
"price_more_than": 10,
"sector": "Technology"
},
"limit": 100
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
is_actively_trading: true,
market_cap_more_than: 1000000000,
price_more_than: 10,
sector: 'Technology'
},
limit: 100
})
};

fetch('https://api.bigdata.com/v1/company-screener/query', 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.bigdata.com/v1/company-screener/query",
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' => [
'is_actively_trading' => true,
'market_cap_more_than' => 1000000000,
'price_more_than' => 10,
'sector' => 'Technology'
],
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.bigdata.com/v1/company-screener/query"

payload := strings.NewReader("{\n \"filters\": {\n \"is_actively_trading\": true,\n \"market_cap_more_than\": 1000000000,\n \"price_more_than\": 10,\n \"sector\": \"Technology\"\n },\n \"limit\": 100\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
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.bigdata.com/v1/company-screener/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"is_actively_trading\": true,\n \"market_cap_more_than\": 1000000000,\n \"price_more_than\": 10,\n \"sector\": \"Technology\"\n },\n \"limit\": 100\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/v1/company-screener/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"is_actively_trading\": true,\n \"market_cap_more_than\": 1000000000,\n \"price_more_than\": 10,\n \"sector\": \"Technology\"\n },\n \"limit\": 100\n}"

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "rp_entity_id": "<string>",
      "symbol": "AAPL",
      "company_name": "Apple Inc.",
      "market_cap": 3000000000000,
      "sector": "Technology",
      "industry": "Consumer Electronics",
      "beta": 1.2,
      "price": 170.5,
      "last_annual_dividend": 0.92,
      "volume": 75000000,
      "exchange": "NASDAQ",
      "exchange_short_name": "NASDAQ",
      "country": "US",
      "is_etf": false,
      "is_actively_trading": true
    }
  ],
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json

Allows filtering companies based on various financial and descriptive criteria.

filters
CompanyScreenerFilters · object | null

Object specifying the filters to apply to the request.

Example:
{
"is_actively_trading": true,
"market_cap_more_than": 1000000000,
"price_more_than": 10,
"sector": "Technology"
}
limit
integer
default:100

Maximum number of records to return (1-1000).

Required range: 1 <= x <= 1000
Example:

100

Response

200 - application/json

Successful Response

Response model for the Company Screener service.

results
ScreenedCompany · object[]
required

List of companies matching the screening criteria.

errors
ErrorDetail · object[] | null
metadata
Metadata · object | null