Yahoo Finance API endpoint
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`.
/yahoo-finance/screener/{id}Path parameters: id.
Query parameters: optional count, offset, sort_field, and sort_asc.
| Field | In the sample | Value in the sample |
|---|---|---|
| id | Has a value | |
| title | Has a value | “Day Gainers” |
| description | Has a value | “Discover the equities with the greatest gains in the tradin…” |
| quotes | Has a value | 20 entries |
| total | Has a value | 57 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| id (path) | string | Yes | Predefined screener id | day_gainers | |
| count | integer | No | Result count | ||
| offset | integer | No | Result offset | ||
| sort_field | string | No | Sort field for offset/customized runs | ||
| sort_asc | boolean | No | Sort ascending | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/yahoo-finance/screener/day_gainers?count=10&sort_asc=true" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"id": "day_gainers",
"title": "Day Gainers",
"quotes": [
{
"symbol": "AAPL"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/yahoofinance.screenerResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | yahoofinance.ScreenerResponse | No | ||||
| data.description | string | No | Description of the screener. | |||
| data.id | string | No | day_gainers | Identifier of the screener, for example `day_gainers`. | ||
| data.meta | object | No | Screener metadata: its canonical name and criteria details. | |||
| data.quotes | array | No | Instruments that match the screener. | |||
| data.title | string | No | Day Gainers | Display title of the screener, for example `Day Gainers`. | ||
| data.total | integer | No | 25 | Total number of instruments that match the screener. | ||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/yahoo-finance/screener/day_gainers?count=10&sort_asc=true" \
-H "x-api-key: $CRAWLORA_API_KEY"