Yahoo Finance

Get Yahoo Finance screener page

Get one page of a Yahoo Finance predefined screener.

GET/v1/yahoo-finance/screeners/{screenerId}
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
6
screenerIdstringrequiredpath

Predefined screener id from the screeners list, e.g. `equity` or `MOST_ACTIVES`.

min 1 chars · max 80 chars

limitintegeroptionalquery

Page size as an integer from 1 to 250. Default: 50.

≥ 1 · ≤ 250

offsetintegeroptionalquery

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.

≥ 0 · ≤ 1000000

sortstringoptionalquery

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.

min 1 chars · max 200 chars

orderstringoptionalquery

Sort direction. Default: `desc`.

one of: asc, desc

cursorstringoptionalquery

Pass `page.nextCursor` from the previous response to get the next page.

min 1 chars · max 1024 chars

Response fields
20

Endpoint-specific response payload.

datalookupStatus
string

Whether the entity was found. HTTP 200 for both outcomes; branch on this field.

one of: found, not_found

datascreenerId
string

Screener id that was requested.

datacanonicalName
stringnullable

The screener's canonical name; null when it has none.

datatitle
stringnullable

Human-readable screener title.

datadescription
stringnullable

Short screener description.

dataquoteType
stringnullable

Instrument kind the screener covers.

datatotal
integernullable

Total matching instruments; null when not reported.

≥ 0

datastart
integer

Zero-based position of the first row.

≥ 0

datacount
integer

Number of rows in this page.

≥ 0

Yahoo Finance JSON records, normalised.

dataquotes[]
objectoptional

A Yahoo Finance JSON record, normalised.

Pagination state for the current page.

datapagehasMore
boolean

Whether another page is available.

datapagenextCursor
stringnullable

Cursor to pass in the next request when more pages exist; null on the last page.

datawindowClamped
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.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/yahoo-finance/screeners/equity?limit=10" \
  -H "x-api-key: YOUR_API_KEY"

Responses

One page of a Yahoo Finance predefined screener.