> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # Get Yahoo Finance screener page (https://www.socialfetch.dev/docs/api/v1/yahoo-finance/screeners/screenerid/get) ## Summary Get one page of a Yahoo Finance predefined screener. **Tags:** `Yahoo Finance` ## HTTP - **Method:** GET - **Path:** `/v1/yahoo-finance/screeners/{screenerId}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.yahooFinance.getScreener({ screenerId: "equity", limit: 10 })` - **Accepted identifiers:** `screenerId` (path) - **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore` - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `screenerId` (path) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 80 - **Description:** Predefined screener id from the screeners list, e.g. `equity` or `MOST_ACTIVES`. ### `limit` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 250 - **Description:** Page size as an integer from 1 to 250. Default: 50. ### `offset` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 0; maximum: 1000000 - **Description:** Zero-based position to begin the list at. Default: 0; maximum: 1,000,000. Only the first 10,000 rows are available; past that the page is empty. ### `sort` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 200 - **Description:** Sort field from the screener field catalogue. Default: the screener's own order. An unknown field is refused for equity and ETF screens; other types are sent as given. ### `order` (query) - **Required:** no - **Constraints:** type `string`; enum: asc, desc - **Description:** Sort direction. Default: `desc`. ### `cursor` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 1024 - **Description:** Pass `page.nextCursor` from the previous response to get the next page. ## Pagination This endpoint uses **cursor-based pagination** via the `cursor` query parameter. - Read **hasMore** from `data.page.hasMore`. - When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string). - Omit `cursor` on the **first** request. - Stop when **hasMore** is `false` or **nextCursor** is null (end of list). ## Responses (status codes) - **200**: One page of a Yahoo Finance predefined screener. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) One page of a Yahoo Finance predefined screener. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the entity was found. HTTP 200 for both outcomes; branch on this field. - **screenerId** (required) — type `string`. Screener id that was requested. - **canonicalName** (required) — type `string`; nullable. The screener's canonical name; null when it has none. - **title** (required) — type `string`; nullable. Human-readable screener title. - **description** (required) — type `string`; nullable. Short screener description. - **quoteType** (required) — type `string`; nullable. Instrument kind the screener covers. - **total** (required) — type `integer`; minimum: 0; nullable. Total matching instruments; null when not reported. - **start** (required) — type `integer`; minimum: 0. Zero-based position of the first row. - **count** (required) — type `integer`; minimum: 0. Number of rows in this page. - **quotes** (required) — type `array`. Yahoo Finance JSON records, normalised. - _items:_ - type `object` - **page** (required) — type `object`. Pagination state for the current page. - **hasMore** (required) — type `boolean`. Whether another page is available. - **nextCursor** (required) — type `string`; nullable. Cursor to pass in the next request when more pages exist; null on the last page. - **windowClamped** (required) — type `boolean`. True when the requested offset is past the reachable rows (later rows would repeat earlier ones); the page then carries only the rows inside the requested window. - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "screenerId": "equity", "canonicalName": "EQUITY", "title": "Equities", "description": "With coverage that spans 50 regions, you can find the best stocks based on your criteria.", "quoteType": "EQUITY", "total": 19844, "start": 0, "count": 5, "quotes": [ { "quoteType": "EQUITY", "typeDisp": "Equity", "quoteSourceName": "Nasdaq Real Time Price", "lastCloseTevEbitLtm": 30.878061, "lastClosePriceToNNWCPerShare": -22.75552185121616, "currency": "USD", "regularMarketChangePercent": 5.30582, "fiftyTwoWeekHigh": 354.47, "fiftyTwoWeekLow": 243.42, "averageAnalystRating": "2.2 - Buy", "dividendYield": 0.33, "financialCurrency": "USD", "shortName": "Apple Inc.", "fulldayPrice": 349.51, "fulldayChange": 17.830017, "fulldayChangePercent": 5.372105, "ask": 352.26, "bid": 349.03, "marketCap": 5079143284736, "exchange": "NMS", "sharesOutstanding": 14532182000, "impliedSharesOutstanding": 14532182000, "bookValue": 7.713, "fiftyDayAverage": 334.0514, "fiftyDayAverageChange": 15.458618, "fiftyDayAverageChangePercent": 0.046276167, "twoHundredDayAverage": 297.33844, "twoHundredDayAverageChange": 52.17157, "forwardPE": 32.823452, "priceToBook": 45.314407, "exchangeDataDelayedBy": 15, "exchangeTimezoneName": "America/New_York", "exchangeTimezoneShortName": "EST", "gmtOffSetMilliseconds": -18000000, "tradeable": false, "cryptoTradeable": false, "longName": "Apple Inc.", "regularMarketOpen": 341.565, "averageDailyVolume3Month": 41614187, "averageDailyVolume10Day": 47776980, "corporateActions": [ { "header": "Dividend", "message": "AAPL announced a cash dividend of $0.27 with an ex-date of Nov. 12, 2026", "meta": { "eventType": "DIVIDEND", "date": "2026-11-12T05:00:00.000Z", "amount": "0.27" } } ], "fiftyTwoWeekLowChange": 106.09001, "fiftyTwoWeekLowChangePercent": 0.43583113, "fiftyTwoWeekRange": "243.42 - 354.47", "fiftyTwoWeekHighChange": -4.9599915, "fiftyTwoWeekHighChangePercent": -0.013992697, "fiftyTwoWeekChangePercent": 22.86222, "dividendDate": "2026-08-13T00:00:00.000Z", "earningsTimestamp": "2026-11-02T21:00:00.000Z", "earningsTimestampStart": "2027-01-28T21:00:00.000Z", "earningsTimestampEnd": "2027-01-28T21:00:00.000Z", "earningsCallTimestampStart": "2026-11-02T22:00:00.000Z", "earningsCallTimestampEnd": "2026-11-02T22:00:00.000Z", "isEarningsDateEstimate": true, "trailingAnnualDividendRate": 1.06, "trailingPE": 38.920937, "hasPrePostMarketData": true, "firstTradeDate": "1980-12-12T14:30:00.000Z", "priceHint": 2, "postMarketChangePercent": 0.36362466, "postMarketTime": "2026-11-05T00:59:51.000Z", "postMarketPrice": 350.7809, "postMarketChange": 1.2709045, "regularMarketChange": 17.61, "regularMarketTime": "2026-11-04T21:00:01.000Z", "regularMarketPrice": 349.51, "regularMarketDayHigh": 354.47, "regularMarketDayRange": "340.99 - 354.47", "regularMarketDayLow": 340.99, "regularMarketVolume": 88958176, "regularMarketPreviousClose": 331.9, "bidSize": 4, "askSize": 6, "market": "us_market", "fullExchangeName": "NasdaqGS", "dividendRate": 1.08, "trailingAnnualDividendYield": 0.003193733, "marketState": "POSTPOST", "epsTrailingTwelveMonths": 8.98, "epsForward": 10.64818, "epsCurrentYear": 9.44849, "priceEpsCurrentYear": 36.991096, "twoHundredDayAverageChangePercent": 0.1754619, "displayName": "Apple", "symbol": "AAPL" } ], "page": { "hasMore": true, "nextCursor": "eyJvIjo1LCJsIjo1LCJmIjoiYTUxOTZhZDUyOGExZDlkOSJ9" }, "windowClamped": false }, "meta": { "requestId": "req_yahoo_finance_example", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.yahooFinance.getScreener({ screenerId: "equity", limit: 10, }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/yahoo-finance/screeners/equity?limit=10", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/yahoo-finance/screeners/equity?limit=10" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/yahoo-finance/screeners/equity?limit=10", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: next page (pagination) After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string): ```javascript const previous = await response.json(); const nextCursor = previous?.data?.page?.nextCursor; const hasMore = previous?.data?.page?.hasMore; if (!hasMore || nextCursor == null) { // no more pages } else { const nextUrl = new URL("https://api.socialfetch.dev/v1/yahoo-finance/screeners/abc123"); nextUrl.searchParams.set("cursor", nextCursor); // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest"); const nextResponse = await fetch(nextUrl.toString(), { headers: { "x-api-key": "YOUR_API_KEY" }, }); const nextData = await nextResponse.json(); } ```