Social Fetch
Start for freeStart free
Yahoo Finance hub

Yahoo Finance Screener Fields API

The field names a screener accepts, grouped by category.

GET /v1/yahoo-finance/screener/fields

1 credit Failed requests are free

Try in playgroundFull API docs

About this endpoint

GET /v1/yahoo-finance/screener/fields?instrumentType=equity returns data.instrumentType, data.fields, data.categories and data.count. Each field carries fieldId, displayName, type, sortable, dropdownSupported, deprecated, isPremium, responseField, categoryId and categoryName.

Use the field catalogue before you post a custom screen: fieldId is what goes in a filter's field, and responseField is the key the quote row uses for output. Premium-flagged fields answer only with a paid login, so they are dropped by default; includePremium=true includes them in the catalogue but does not make them usable. Categories group the fields for building a picker.

Yahoo Finance Screener Fields API FAQ

How do I use the catalogue?

Use fieldId in a custom screener filter and responseField when you read the returned quote row. The category fields group the picker.

What happens to premium fields?

They are dropped unless includePremium=true, because they cannot be used without a paid login. Including them in the catalogue does not make them usable in a screen.

What does sortable mean?

The field can be used in sort. dropdownSupported means Yahoo Finance offers it as a dropdown choice. Either can be null when not reported.

How many credits does this route cost?

Pricing is documented on the operation in the API registry (shown on this page). Confirm on every response with meta.creditsCharged: that field is the billing source of truth.

Other Yahoo Finance endpoints