Yahoo Finance

List Yahoo Finance screener fields

List Yahoo Finance screener filter and output fields by instrument type.

GET/v1/yahoo-finance/screener/fields
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
2
instrumentTypestringquery

Instrument type. Default: `equity`.

one of: equity, etf, mutualfund, crypto, index, future, currency, option

includePremiumbooleanquery

Include fields flagged premium. Default: false.

Response fields
20

Endpoint-specific response payload.

datainstrumentType
string

Instrument type the catalogue is for.

Filter and output fields for this instrument type.

datafields[]fieldId
string

Field id to use in a filter or sort.

datafields[]displayName
stringnullable

Human-readable field name.

datafields[]type
stringnullable

Value type the field accepts.

datafields[]sortable
booleannullable

Whether the field can be used for sorting.

datafields[]dropdownSupported
booleannullable

Whether the field can be used as a dropdown filter.

datafields[]deprecated
booleannullable

Whether the field is deprecated.

datafields[]isPremium
booleannullable

Whether the field requires a paid login.

datafields[]responseField
stringnullable

Response property the field populates, when any.

datafields[]categoryId
stringnullable

Category id the field belongs to.

datafields[]categoryName
stringnullable

Category display name.

The catalogue's groups, with their display names.

datacategories[]
objectoptional

A Yahoo Finance JSON record, normalised.

datacount
integer

Number of fields in the catalogue.

≥ 0

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/screener/fields?instrumentType=equity" \
  -H "x-api-key: YOUR_API_KEY"

Responses

The Yahoo Finance screener field catalogue.