---
title: "Yahoo Finance custom screener"
method: POST
path: "/yahoo-finance/screener"
tags: ["Yahoo Finance"]
---

# Yahoo Finance custom screener

`POST /yahoo-finance/screener`

## Request

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

Runs a custom Yahoo Finance screen from a JSON body. `query` is a tree of `operator` and `operands`: combine conditions with `AND` or `OR`, and compare a field to a value with operators such as `EQ` or `GT`. Screen equities (default), ETFs or mutual funds with `quote_type`, and page and sort with `count`, `offset`, `sort_field` and `sort_asc`. Returns the matching quotes and the total.

## Headers

- `x-api-key` string, required

## Request body

- YahoofinanceScreenerRequest
  - `count` integer
  - `offset` integer
  - `query` object, required
  - `quote_type` string
  - `sort_asc` boolean
  - `sort_field` string

## 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)