Screen the companies StockLens scores nightly by region, exchange, sector, industry, market-cap band and trading volume, sorted by one of the six StockLens scores or by market cap, volume or ticker, and return the top or bottom N. Every list is computed inside one listing market: the one named in macro_in or exchange_in, otherwise the United States, and market and market_name in the result name it, so always say which market the rows are from. For another market (US, CA, EU, CH, GB, JP), call again naming it; never merge or compare lists across markets. multiple_markets and market_not_covered mean nothing was ranked: relay message. Popularity ordering is unavailable: analysis_volume and user_volume are retired and return VALIDATION_ERROR without running a screen. For a popularity request, ask the person to choose a supported ordering. Use it for any top N, best, worst, highest, lowest or filtered request across the companies StockLens scores, and never build such a list from get_market_summary or general knowledge; to compare only companies the person names, call get_shortlist_summary instead. It has no valuation, price-target or growth filter; say so rather than calling a score sort one. status ranked means the requested order was used. When a ranked result carries message, relay it; it states what the ranking covers, so never present the rows as a ranking of more than that. browse_substituted means a score order was asked for and market-cap order with scores hidden was returned, so never describe those rows as ranked by score. locked means no companies are named; relay message verbatim. What the caller can sort and how far it reaches is in access_tier and reach_capped_at; signed_in_as names the account they belong to. Report every returned row in its actual order and retain the population and access/substitution message. Where reading_ref and inspection are supplied, inspect only the company the person asks about; never fetch every row. It does not trade and gives no personal recommendations. A successful result counts once toward the person's weekly research allowance; a RATE_LIMITED result states the limit and when it renews, so relay it and do not call again before then.
View input schema
{
"type": "object",
"properties": {
"macro_in": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"enum": [
"US",
"CA",
"EU",
"CH",
"GB",
"JP"
]
},
"description": "Listing market to rank in, where the companies list: US, CA, EU, CH, GB or JP. Every answer is computed inside one listing market, the one named here or by exchange_in, otherwise the United States, and market and market_name in the result say which. For another market, name it, for example JP. Several markets in one call are refused: call once per market and never merge the lists."
},
"exchange_in": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"enum": [
"NYSE",
"NASDAQ",
"AMEX",
"OTC",
"CBOE",
"TSX",
"TSXV",
"CNQ",
"NEO",
"MEX",
"B3",
"SANTIAGO",
"BUE",
"BVC",
"LSE",
"EURONEXT_PARIS",
"EURONEXT_AMSTERDAM",
"EURONEXT_BRUSSELS",
"EURONEXT_LISBON",
"EURONEXT_DUBLIN",
"XETRA",
"SIX",
"BME",
"MILAN",
"OSLO",
"OMX_STOCKHOLM",
"OMX_HELSINKI",
"OMX_COPENHAGEN",
"WSE",
"VIE",
"ATH",
"PRA",
"BUD",
"IST",
"ICE",
"RIS",
"TAL",
"MCX",
"TSE",
"HKEX",
"SHANGHAI",
"SHENZHEN",
"ASX",
"TWSE",
"SGX",
"NSE",
"KRX",
"BSE",
"KOE",
"JKT",
"KLS",
"SET",
"NZE",
"HOSE",
"TWO",
"TADAWUL",
"JSE",
"TLV",
"DFM",
"EGX",
"DOH",
"KUW"
]
},
"description": "Restrict to these exchanges, all inside one listing market. Every answer is computed inside one listing market, the one these exchanges or macro_in belong to, otherwise the United States, and market and market_name in the result say which. Exchanges of different markets are refused: call once per market."
},
"sector_in": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"enum": [
"BASIC_MATERIALS",
"COMMUNICATION_SERVICES",
"CONSUMER_CYCLICAL",
"CONSUMER_DEFENSIVE",
"ENERGY",
"FINANCIAL_SERVICES",
"HEALTHCARE",
"INDUSTRIALS",
"REAL_ESTATE",
"TECHNOLOGY",
"UTILITIES",
"UNKNOWN"
]
},
"description": "Restrict to these GICS sectors. Omitted = no restriction."
},
"industry_in": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"enum": [
"STEEL",
"SILVER",
"OTHER_PRECIOUS_METALS",
"GOLD",
"COPPER",
"ALUMINUM",
"PAPER_LUMBER_FOREST_PRODUCTS",
"INDUSTRIAL_MATERIALS",
"CONSTRUCTION_MATERIALS",
"CHEMICALS_SPECIALTY",
"CHEMICALS",
"AGRICULTURAL_INPUTS",
"TELECOMMUNICATIONS_SERVICES",
"INTERNET_CONTENT_INFORMATION",
"PUBLISHING",
"BROADCASTING",
"ADVERTISING_AGENCIES",
"ENTERTAINMENT",
"TRAVEL_LODGING",
"TRAVEL_SERVICES",
"SPECIALTY_RETAIL",
"LUXURY_GOODS",
"HOME_IMPROVEMENT",
"RESIDENTIAL_CONSTRUCTION",
"DEPARTMENT_STORES",
"PERSONAL_PRODUCTS_SERVICES",
"LEISURE",
"GAMBLING_RESORTS_CASINOS",
"FURNISHINGS_FIXTURES_APPLIANCES",
"RESTAURANTS",
"AUTO_PARTS",
"AUTO_MANUFACTURERS",
"AUTO_RECREATIONAL_VEHICLES",
"AUTO_DEALERSHIPS",
"APPAREL_RETAIL",
"APPAREL_MANUFACTURERS",
"APPAREL_FOOTWEAR_ACCESSORIES",
"PACKAGING_CONTAINERS",
"TOBACCO",
"GROCERY_STORES",
"DISCOUNT_STORES",
"HOUSEHOLD_PERSONAL_PRODUCTS",
"PACKAGED_FOODS",
"FOOD_DISTRIBUTION",
"FOOD_CONFECTIONERS",
"AGRICULTURAL_FARM_PRODUCTS",
"EDUCATION_TRAINING_SERVICES",
"BEVERAGES_WINERIES_DISTILLERIES",
"BEVERAGES_NON_ALCOHOLIC",
"BEVERAGES_ALCOHOLIC",
"URANIUM",
"SOLAR",
"OIL_GAS_REFINING_MARKETING",
"OIL_GAS_MIDSTREAM",
"OIL_GAS_INTEGRATED",
"OIL_GAS_EXPLORATION_PRODUCTION",
"OIL_GAS_EQUIPMENT_SERVICES",
"OIL_GAS_ENERGY",
"OIL_GAS_DRILLING",
"COAL",
"SHELL_COMPANIES",
"INVESTMENT_BANKING_INVESTMENT_SERVICES",
"INSURANCE_SPECIALTY",
"INSURANCE_REINSURANCE",
"INSURANCE_PROPERTY_CASUALTY",
"INSURANCE_LIFE",
"INSURANCE_DIVERSIFIED",
"INSURANCE_BROKERS",
"FINANCIAL_MORTGAGES",
"FINANCIAL_DIVERSIFIED",
"FINANCIAL_DATA_STOCK_EXCHANGES",
"FINANCIAL_CREDIT_SERVICES",
"FINANCIAL_CONGLOMERATES",
"FINANCIAL_CAPITAL_MARKETS",
"BANKS_REGIONAL",
"BANKS_DIVERSIFIED",
"BANKS",
"ASSET_MANAGEMENT",
"ASSET_MANAGEMENT_BONDS",
"ASSET_MANAGEMENT_INCOME",
"ASSET_MANAGEMENT_LEVERAGED",
"ASSET_MANAGEMENT_CRYPTOCURRENCY",
"ASSET_MANAGEMENT_GLOBAL",
"MEDICAL_SPECIALTIES",
"MEDICAL_PHARMACEUTICALS",
"MEDICAL_INSTRUMENTS_SUPPLIES",
"MEDICAL_HEALTHCARE_PLANS",
"MEDICAL_HEALTHCARE_INFORMATION_SERVICES",
"MEDICAL_EQUIPMENT_SERVICES",
"MEDICAL_DISTRIBUTION",
"MEDICAL_DIAGNOSTICS_RESEARCH",
"MEDICAL_DEVICES",
"MEDICAL_CARE_FACILITIES",
"DRUG_MANUFACTURERS_SPECIALTY_GENERIC",
"DRUG_MANUFACTURERS_GENERAL",
"BIOTECHNOLOGY",
"WASTE_MANAGEMENT",
"TRUCKING",
"RAILROADS",
"AEROSPACE_DEFENSE",
"MARINE_SHIPPING",
"INTEGRATED_FREIGHT_LOGISTICS",
"AIRLINES_AIRPORTS_AIR_SERVICES",
"GENERAL_TRANSPORTATION",
"MANUFACTURING_TOOLS_ACCESSORIES",
"MANUFACTURING_TEXTILES",
"MANUFACTURING_MISCELLANEOUS",
"MANUFACTURING_METAL_FABRICATION",
"INDUSTRIAL_DISTRIBUTION",
"INDUSTRIAL_SPECIALTIES",
"INDUSTRIAL_POLLUTION_TREATMENT_CONTROLS",
"ENVIRONMENTAL_SERVICES",
"INDUSTRIAL_MACHINERY",
"INDUSTRIAL_INFRASTRUCTURE_OPERATIONS",
"INDUSTRIAL_CAPITAL_GOODS",
"CONSULTING_SERVICES",
"BUSINESS_EQUIPMENT_SUPPLIES",
"STAFFING_EMPLOYMENT_SERVICES",
"RENTAL_LEASING_SERVICES",
"ENGINEERING_CONSTRUCTION",
"SECURITY_PROTECTION_SERVICES",
"SPECIALTY_BUSINESS_SERVICES",
"CONSTRUCTION",
"CONGLOMERATES",
"ELECTRICAL_EQUIPMENT_PARTS",
"AGRICULTURAL_MACHINERY",
"AGRICULTURAL_COMMODITIES_MILLING",
"REIT_SPECIALTY",
"REIT_RETAIL",
"REIT_RESIDENTIAL",
"REIT_OFFICE",
"REIT_MORTGAGE",
"REIT_INDUSTRIAL",
"REIT_HOTEL_MOTEL",
"REIT_HEALTHCARE_FACILITIES",
"REIT_DIVERSIFIED",
"REAL_ESTATE_SERVICES",
"REAL_ESTATE_DIVERSIFIED",
"REAL_ESTATE_DEVELOPMENT",
"REAL_ESTATE_GENERAL",
"INFORMATION_TECHNOLOGY_SERVICES",
"HARDWARE_EQUIPMENT_PARTS",
"COMPUTER_HARDWARE",
"ELECTRONIC_GAMING_MULTIMEDIA",
"SOFTWARE_SERVICES",
"SOFTWARE_INFRASTRUCTURE",
"SOFTWARE_APPLICATION",
"SEMICONDUCTORS",
"MEDIA_ENTERTAINMENT",
"COMMUNICATION_EQUIPMENT",
"TECHNOLOGY_DISTRIBUTORS",
"CONSUMER_ELECTRONICS",
"RENEWABLE_UTILITIES",
"REGULATED_WATER",
"REGULATED_GAS",
"REGULATED_ELECTRIC",
"INDEPENDENT_POWER_PRODUCERS",
"DIVERSIFIED_UTILITIES",
"GENERAL_UTILITIES",
"UNKNOWN"
]
},
"description": "Restrict to these GICS industries. Omitted = no restriction."
},
"market_cap_band": {
"type": "string",
"description": "Restrict to this market-cap band. Omitted = no cap restriction.",
"enum": [
"MEGA",
"LARGE",
"MID",
"SMALL",
"MICRO"
]
},
"volume_floor": {
"type": "string",
"description": "Minimum average trading volume. Omitted = no floor.",
"enum": [
"100K",
"500K",
"1M",
"5M"
]
},
"sort_by": {
"type": "string",
"description": "One of the 6 StockLens scores, market_cap, volume or ticker. Default composite_score. Popularity ordering is unavailable.",
"enum": [
"composite_score",
"fundamental_score",
"technical_score",
"risk_score",
"sentiment_score",
"macro_score",
"ticker",
"market_cap",
"volume"
]
},
"direction": {
"type": "string",
"description": "top = highest first, bottom = lowest first. Default top.",
"enum": [
"top",
"bottom"
]
},
"limit": {
"type": "integer",
"description": "Number of matches to return (the N in top/bottom N), 1 to 100. Default 10.",
"minimum": 1,
"maximum": 100
},
"page": {
"type": "integer",
"description": "0-based page of results, 0 to 500. Default 0.",
"minimum": 0,
"maximum": 500
},
"search_text": {
"type": "string",
"description": "Free-text company name/ticker search, up to 80 characters."
}
},
"additionalProperties": false
}