---
title: "Yahoo Finance predefined screener results"
method: GET
path: "/yahoo-finance/screener/{id}"
tags: ["Yahoo Finance"]
---

# Yahoo Finance predefined screener results

`GET /yahoo-finance/screener/{id}`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/yahoo-finance/screener/{id}`
- Auth: API key in header `x-api-key`

Runs a predefined Yahoo Finance screener by `id`, such as `day_gainers` or `most_actives`. `count` and `offset` page the results; `sort_field` and `sort_asc` change the order. The response has the screener `title`, `description`, `total`, `meta` and the matching `quotes`. Valid ids come from `/yahoo-finance/screeners`.

## Path parameters

- `id` string, required

## Query parameters

- `count` integer
- `offset` integer
- `sort_field` string
- `sort_asc` boolean

## Headers

- `x-api-key` string, required

## Response `200`

OK

- YahoofinanceScreenerResponseDoc
  - `code` integer
  - `data` YahoofinanceScreenerResponse
    - `description` string: Description of the screener.
    - `id` string: Identifier of the screener, for example `day_gainers`.
    - `meta` object: Screener metadata: its canonical name and criteria details.
    - `quotes` object[]: Instruments that match the screener.
    - `title` string: Display title of the screener, for example `Day Gainers`.
    - `total` integer: Total number of instruments that match the screener.
  - `msg` string

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)