{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Scraper: Quotes, History, Financials", "description": "Scrape Yahoo Finance for any ticker list, no login or API key: stocks, ETFs, funds, indices, currencies, crypto. Quotes with the exchange delay, daily or intraday history, annual and quarterly statements, analyst targets, news, options, screeners. Pay per row, JSON or CSV; misses are free.", "version": "0.1", "x-build-id": "5u8eVYYMpPRaivulc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~yahoo-finance-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-yahoo-finance-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/automation_craft~yahoo-finance-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-yahoo-finance-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/automation_craft~yahoo-finance-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-yahoo-finance-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "tickers": { "title": "Tickers", "type": "array", "description": "Yahoo Finance ticker symbols, exactly as Yahoo shows them: AAPL, BRK-B, ^GSPC (index), EURUSD=X (currency), BTC-USD (crypto), ES=F (future), 0700.HK or RELIANCE.NS (other exchanges). Lower case, a leading $ and a pasted finance.yahoo.com quote link are accepted. A symbol Yahoo does not know costs nothing and comes back as a free row with Yahoo's own suggestions.", "items": { "type": "string" } }, "dataTypes": { "title": "Data types", "type": "array", "description": "What to return for every ticker. quote: price, change, volume, market cap, ranges, valuation ratios and the exchange delay (one Quote row). history: candles with dividends and splits. financials: income statement, balance sheet and cash flow lines, annual and quarterly. profile: company or fund profile, key statistics, holders, insider transactions, filings. analyst: recommendations, price targets, estimates, earnings history, rating changes. news: latest headlines. options: the option chain per expiry. Each type other than quote is one Ticker record per ticker (options: one per expiry).", "items": { "type": "string", "enum": [ "quote", "history", "financials", "profile", "analyst", "news", "options" ], "enumTitles": [ "Quote (price and key figures)", "Price history (candles, dividends, splits)", "Financial statements (annual and quarterly)", "Profile, key statistics and holders", "Analyst data (recommendations, targets, estimates)", "News headlines", "Option chain" ] }, "default": [ "quote" ] }, "historyRange": { "title": "History range", "enum": [ "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max" ], "type": "string", "description": "How far back the candles go. Ignored when a start date is set. Yahoo keeps 1 minute candles for 30 days (at most 8 days per run), 2 to 90 minute candles for 60 days and 1 hour and 4 hour candles for 730 days; a window outside those limits is refused before anything is charged.", "default": "1mo" }, "historyInterval": { "title": "Candle interval", "enum": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "4h", "1d", "5d", "1wk", "1mo", "3mo" ], "type": "string", "description": "Length of one candle. Daily (1d) is the default; 1wk and 1mo give weekly and monthly candles; the minute and hour intervals are intraday and Yahoo keeps them for a limited time (see History range).", "default": "1d" }, "historyStart": { "title": "History start date", "type": "string", "description": "Optional. First day of the window as YYYY-MM-DD (UTC). When set, it replaces the range. Example: 2020-01-01." }, "historyEnd": { "title": "History end date", "type": "string", "description": "Optional. Last day of the window as YYYY-MM-DD (UTC), inclusive. Needs a start date. Empty means up to now." }, "historyOutput": { "title": "History output", "enum": [ "nested", "rows" ], "type": "string", "description": "nested: one Ticker record per ticker with the candles, dividends and splits inside (cheapest, one event per ticker). rows: one Candle row per candle, ready for CSV and spreadsheets (one small event per candle; dividends and splits are in the nested record only).", "default": "nested" }, "includePrePost": { "title": "Include pre-market and after-hours candles", "type": "boolean", "description": "Intraday intervals only: also return candles from the extended trading sessions.", "default": false }, "statements": { "title": "Statements", "type": "array", "description": "Which statements to include.", "items": { "type": "string", "enum": [ "income", "balance", "cashflow" ], "enumTitles": [ "Income statement", "Balance sheet", "Cash flow statement" ] }, "default": [ "income", "balance", "cashflow" ] }, "statementPeriods": { "title": "Statement periods", "type": "array", "description": "annual: the fiscal years Yahoo publishes (usually 4). quarterly: the latest quarters (usually 5). trailing: trailing twelve months figures for the income and cash flow statements.", "items": { "type": "string", "enum": [ "annual", "quarterly", "trailing" ], "enumTitles": [ "Annual", "Quarterly", "Trailing twelve months" ] }, "default": [ "annual", "quarterly" ] }, "maxNewsPerTicker": { "title": "News per ticker", "minimum": 1, "maximum": 50, "type": "integer", "description": "Newest headlines to return per ticker, from 1 to 50. Yahoo usually has 15 to 30 for a large United States company and fewer or none for small or foreign ones.", "default": 20 }, "newsOutput": { "title": "News output", "enum": [ "nested", "rows" ], "type": "string", "description": "nested: one Ticker record per ticker with the headlines inside (one event per ticker). rows: one News article row per headline, ready for CSV (one small event per headline).", "default": "nested" }, "maxOptionExpirations": { "title": "Option expiries per ticker", "minimum": 1, "maximum": 60, "type": "integer", "description": "How many expiry dates to return per ticker, nearest first, from 1 to 60. Each expiry is one Ticker record with every call and put of that date.", "default": 1 }, "screeners": { "title": "Screeners", "type": "array", "description": "Predefined Yahoo Finance screeners and the trending tickers list, returned as Quote rows (same fields as a quote, plus the screener name and the rank). 50 lists: gainers, losers, most active, 52 week highs and lows, value and growth screens, the eleven sectors, ETFs, mutual funds, cryptocurrencies and option lists. A symbol that already came back as a quote in the same run is repeated for free.", "items": { "type": "string", "enum": [ "day_gainers", "day_losers", "most_actives", "trending_us", "most_watched_tickers", "most_shorted_stocks", "fifty_two_wk_gainers", "fifty_two_wk_losers", "undervalued_growth_stocks", "undervalued_large_caps", "strong_undervalued_stocks", "growth_technology_stocks", "aggressive_small_caps", "small_cap_gainers", "high_dividend_yield", "morningstar_five_star_stocks", "upside_breakout_stocks_daily", "the_acquirers_multiple", "day_gainers_dji", "day_losers_dji", "most_actives_dji", "day_gainers_ndx", "most_actives_gb", "day_gainers_gb", "ms_basic_materials", "ms_communication_services", "ms_consumer_cyclical", "ms_consumer_defensive", "ms_energy", "ms_financial_services", "ms_healthcare", "ms_industrials", "ms_real_estate", "ms_technology", "ms_utilities", "top_etfs_us", "top_performing_etfs", "most_actives_etfs", "technology_etfs", "bond_etfs", "top_mutual_funds", "portfolio_anchors", "solid_large_growth_funds", "solid_midcap_growth_funds", "conservative_foreign_funds", "high_yield_bond", "all_cryptocurrencies_us", "most_actives_options", "top_options_open_interest", "top_options_implied_volatality" ], "enumTitles": [ "Day gainers", "Day losers", "Most active", "Trending tickers (US)", "Most added to watchlists", "Most shorted stocks", "52 week gainers", "52 week losers", "Undervalued growth stocks", "Undervalued large caps", "Strong undervalued stocks", "Growth technology stocks", "Aggressive small caps", "Small caps with momentum", "High dividend yield", "Morningstar 5 star stocks", "Upside breakout stocks", "The Acquirer's Multiple", "Day gainers, Dow Jones Industrials", "Day losers, Dow Jones Industrials", "Most active, Dow Jones Industrials", "Day gainers, NASDAQ 100", "Most active, United Kingdom", "Day gainers, United Kingdom", "Sector: basic materials", "Sector: communication services", "Sector: consumer cyclical", "Sector: consumer defensive", "Sector: energy", "Sector: financial services", "Sector: healthcare", "Sector: industrials", "Sector: real estate", "Sector: technology", "Sector: utilities", "Top ETFs (US)", "Top performing ETFs", "Most active ETFs", "Technology ETFs", "Bond ETFs", "Top mutual funds", "Portfolio anchors (funds)", "Solid large growth funds", "Solid mid cap growth funds", "Conservative foreign funds", "High yield bond funds", "All cryptocurrencies", "Most active options", "Options with the highest open interest", "Options with the highest implied volatility" ] } }, "maxScreenerRows": { "title": "Rows per screener", "minimum": 1, "maximum": 250, "type": "integer", "description": "Top rows to return per screener, from 1 to 250 (the trending list has at most 50).", "default": 25 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }