Skip to main content
POST
/
v1
/
company-screener
/
query
Company 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 '{
  "market_cap_more_than": 1000000000,
  "market_cap_lower_than": 10000000000,
  "price_more_than": 10,
  "price_lower_than": 200,
  "beta_more_than": 0.5,
  "beta_lower_than": 2,
  "volume_more_than": 1000000,
  "volume_lower_than": 10000000,
  "dividend_more_than": 0.1,
  "dividend_lower_than": 5,
  "is_etf": false,
  "is_fund": false,
  "is_actively_trading": true,
  "sector": "Technology",
  "industry": "Semiconductors",
  "country": "US",
  "exchange": "NASDAQ",
  "limit": 10
}'
{
  "results": [
    {
      "rp_entity_id": "4A6F00",
      "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>"
    }
  ],
  "pagination": {
    "cursor": "00000DexaRK4NT6t",
    "has_cursor": true
  },
  "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.

​
market_cap_more_than
integer | null

Minimum market capitalization in USD.

Required range: x > 0
Examples:

1000000000

​
market_cap_lower_than
integer | null

Maximum market capitalization in USD.

Required range: x > 0
Examples:

10000000000

​
price_more_than
number | null

Minimum stock price in USD.

Required range: x > 0
Examples:

10

​
price_lower_than
number | null

Maximum stock price in USD.

Required range: x > 0
Examples:

200

​
beta_more_than
number | null

Minimum beta value.

Examples:

0.5

​
beta_lower_than
number | null

Maximum beta value.

Examples:

2

​
volume_more_than
integer | null

Minimum trading volume.

Required range: x >= 0
Examples:

1000000

​
volume_lower_than
integer | null

Maximum trading volume.

Required range: x >= 0
Examples:

10000000

​
dividend_more_than
number | null

Minimum annual dividend in USD.

Required range: x >= 0
Examples:

0.1

​
dividend_lower_than
number | null

Maximum annual dividend in USD.

Required range: x >= 0
Examples:

5

​
is_etf
boolean | null

Whether to include ETFs in the results.

Examples:

false

​
is_fund
boolean | null

Whether to include mutual funds in the results.

Examples:

false

​
is_actively_trading
boolean | null

Whether to include only actively trading stocks.

Examples:

true

​
sector

Sector of the company. Sector enum for public API.

Available options:
Basic Materials,
Communication Services,
Consumer Cyclical,
Consumer Defensive,
Energy,
Financial Services,
Healthcare,
Industrials,
Real Estate,
Technology,
Utilities
Examples:

"Technology"

​
industry

Industry of the company. Industry enum for public API.

Available options:
Semiconductors,
Banks,
Biotechnology,
Software - Application,
Consumer Electronics
Examples:

"Semiconductors"

​
country
enum<string> | null

Country code of the company (ISO 3166-1 alpha-2).

Available options:
AW,
AF,
AO,
AI,
AX,
AL,
AD,
AE,
AR,
AM,
AS,
AQ,
TF,
AG,
AU,
AT,
AZ,
BI,
BE,
BJ,
BQ,
BF,
BD,
BG,
BH,
BS,
BA,
BL,
BY,
BZ,
BM,
BO,
BR,
BB,
BN,
BT,
BV,
BW,
CF,
CA,
CC,
CH,
CL,
CN,
CI,
CM,
CD,
CG,
CK,
CO,
KM,
CV,
CR,
CU,
CW,
CX,
KY,
CY,
CZ,
DE,
DJ,
DM,
DK,
DO,
DZ,
EC,
EG,
ER,
EH,
ES,
EE,
ET,
FI,
FJ,
FK,
FR,
FO,
FM,
GA,
GB,
GE,
GG,
GH,
GI,
GN,
GP,
GM,
GW,
GQ,
GR,
GD,
GL,
GT,
GF,
GU,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IM,
IN,
IO,
IE,
IR,
IQ,
IS,
IL,
IT,
JM,
JE,
JO,
JP,
KZ,
KE,
KG,
KH,
KI,
KN,
KR,
KW,
LA,
LB,
LR,
LY,
LC,
LI,
LK,
LS,
LT,
LU,
LV,
MO,
MF,
MA,
MC,
MD,
MG,
MV,
MX,
MH,
MK,
ML,
MT,
MM,
ME,
MN,
MP,
MZ,
MR,
MS,
MQ,
MU,
MW,
MY,
YT,
NA,
NC,
NE,
NF,
NG,
NI,
NU,
NL,
NO,
NP,
NR,
NZ,
OM,
PK,
PA,
PN,
PE,
PH,
PW,
PG,
PL,
PR,
KP,
PT,
PY,
PS,
PF,
QA,
RE,
RO,
RU,
RW,
SA,
SD,
SN,
SG,
GS,
SH,
SJ,
SB,
SL,
SV,
SM,
SO,
PM,
RS,
SS,
ST,
SR,
SK,
SI,
SE,
SZ,
SX,
SC,
SY,
TC,
TD,
TG,
TH,
TJ,
TK,
TM,
TL,
TO,
TT,
TN,
TR,
TV,
TW,
TZ,
UG,
UA,
UM,
UY,
US,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
ZA,
ZM,
ZW
Examples:

"US"

​
exchange
string | null

Exchange code of the company.

Examples:

"NASDAQ"

​
limit
integer
default:100

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

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

10

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
​
pagination
object | null

Common pagination response for endpoints that support pagination.

​
metadata
object | null