Yahoo Finance API endpoint
Looks up instruments on Yahoo Finance by ticker symbol or company name, optionally filtered to one type: equity, ETF, mutual fund, index, future, currency or cryptocurrency. Page with `count` and `start`. Returns the matching instruments, each with its symbol, short name, quote type and exchange, and the total.
/yahoo-finance/lookupReturns Yahoo Finance instrument matches for a ticker or company query, optionally filtered by instrument type.
Query parameters: query is required. Optional parameters are type, count, and start. The type filter accepts all, equity, etf, mutualfund, index, future, currency, or cryptocurrency (default all).
| Field | Filled in, of 20 checked | Values in the sample |
|---|---|---|
| exchange | 20 | “NMS” and 15 other values |
| fulldayChange | 20 | 0 to 540, median 2.54 |
| fulldayChangePercent | 20 | 0 to 46.08, median 1.2 |
| fulldayPrice | 20 | 0.19 to 1,089,860, median 307.35 |
| industryLink | 12 | finance.yahoo.com |
| industryName | 12 | Technology (10), Real Estate (1), Consumer Cyclical (1) |
| quoteType | 20 | equity (12), etf (4), future (2) and 1 more |
| rank | 20 | 20,015 to 361,633, median 20,034 |
| regularMarketChange | 20 | 0 to 540, median 2.54 |
| regularMarketPercentChange | 20 | 0 to 46.08, median 1.25 |
| regularMarketPrice | 20 | 0.19 to 1,089,860, median 307.35 |
| shortName | 20 | “Apple Inc.” and 15 other values |
| symbol | 20 | “AAPL” and 19 other values |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| query | string | Yes | Ticker symbol or company name | apple | |
| type | string | No | Instrument type filter Allowed values: all, equity, etf, mutualfund, index, future, currency, cryptocurrency. | ||
| count | integer | No | Result count | ||
| start | integer | No | Result offset | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/yahoo-finance/lookup?query=apple&type=all&count=10" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"query": "apple",
"type": "all",
"start": 0,
"count": 10,
"total": 10,
"documents": [
{
"symbol": "AAPL",
"shortName": "Apple Inc.",
"quoteType": "equity",
"exchange": "NMS"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/yahoofinance.lookupResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | yahoofinance.LookupResponse | No | ||||
| data.count | integer | No | 10 | Number of documents returned. | ||
| data.documents | array | No | Matching instruments, one object per match. | |||
| data.query | string | No | apple | Lookup text that was run. | ||
| data.start | integer | No | 0 | Zero-based offset of the first result. | ||
| data.total | integer | No | 10 | Total number of matches reported by Yahoo Finance. | ||
| data.type | string | No | all | Instrument type filter applied, for example `all`. | ||
| 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/lookup?query=apple&type=all&count=10" \
-H "x-api-key: $CRAWLORA_API_KEY"