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
}'
{
  "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>"
    }
  ],
  "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
object | null

Object specifying the filters to apply to the request. Filters for the company screener request.

Examples:
{
"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
Examples:

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