Skip to main content
GET
/
screener
Get stock screener results
curl --request GET \
  --url https://api.fcontext.com/screener \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": [
    {
      "symbol": "AAPL",
      "shortName": "Apple Inc.",
      "regularMarketPrice": 185.64,
      "regularMarketChange": 2.15,
      "regularMarketChangePercent": 1.17,
      "regularMarketVolume": 45820300,
      "marketCap": 2890000000000,
      "averageVolume": 58465000,
      "fiftyTwoWeekHigh": 198.23,
      "fiftyTwoWeekLow": 164.08,
      "priceToEarningsRatio": 28.5,
      "dividendYield": 0.52,
      "exchange": "NASDAQ",
      "currency": "USD"
    },
    {
      "symbol": "MSFT",
      "shortName": "Microsoft Corporation",
      "regularMarketPrice": 374.58,
      "regularMarketChange": 5.23,
      "regularMarketChangePercent": 1.42,
      "regularMarketVolume": 23456000,
      "marketCap": 2780000000000,
      "averageVolume": 28950000,
      "fiftyTwoWeekHigh": 384.3,
      "fiftyTwoWeekLow": 309.45,
      "priceToEarningsRatio": 32.1,
      "dividendYield": 0.68,
      "exchange": "NASDAQ",
      "currency": "USD"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 25,
    "hasMore": false,
    "totalItems": 2
  },
  "message": "Screener data retrieved successfully",
  "timestamp": "2024-01-02T12:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.fcontext.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
scrIds
enum<string>
required

Select a predefined screening strategy to filter stocks

Available options:
aggressive_small_caps,
conservative_foreign_funds,
day_gainers,
day_losers,
growth_technology_stocks,
high_yield_bond,
most_actives,
most_shorted_stocks,
portfolio_anchors,
small_cap_gainers,
solid_large_growth_funds,
solid_midcap_growth_funds,
top_mutual_funds,
undervalued_growth_stocks,
undervalued_large_caps
Examples:

"day_gainers"

"most_actives"

"growth_technology_stocks"

​
count
integer
default:25

Maximum number of stocks to return in the response

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

10

25

50

100

​
region
string

Geographic market region to filter stocks

Examples:

"US"

"GB"

"CA"

"AU"

"DE"

​
lang
string

Language preference for localized content

Examples:

"en-US"

"en-GB"

"fr-FR"

"de-DE"

"es-ES"

Response

Screener results retrieved successfully

Complete response structure for stock screening requests

​
success
boolean
required

Indicates successful API response

​
data
Stock Information · object[]
required

List of stocks that match the specified screening criteria

Example:
[
  {
    "symbol": "AAPL",
    "shortName": "Apple Inc.",
    "regularMarketPrice": 185.64,
    "regularMarketChange": 2.15,
    "regularMarketChangePercent": 1.17
  }
]
​
timestamp
string
required

ISO 8601 timestamp of the response

​
pagination
Pagination Details · object

Information about result pagination and total counts

​
message
string

Optional success message

​
meta
object

Optional metadata including pagination, statistics, and additional context