{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Scraper - Quotes, Financials, Options & History", "description": "Scrape Yahoo Finance by ticker, search or screener: price, market cap, P/E, EPS, dividends, statements, earnings, analyst targets, holders, insiders, SEC filings, transcripts, options with Greeks, OHLCV history and news. Monitor mode. $0.36 per 1,000 tickers, no start fee.", "version": "0.1", "x-build-id": "Lrf7x4WPuaV9hgjv2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/topapi~yahoo-finance-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-topapi-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/topapi~yahoo-finance-scraper/runs": { "post": { "operationId": "runs-sync-topapi-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/topapi~yahoo-finance-scraper/run-sync": { "post": { "operationId": "run-sync-topapi-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 symbols, finance.yahoo.com/quote links, company names or ISINs, one per line, e.g. AAPL, BRK-B, SAP.DE, 7203.T, SPY, ^GSPC, BTC-USD, EURUSD=X, GC=F, \"apple\", US0378331005.", "items": { "type": "string" } }, "startUrls": { "title": "Quote URLs", "type": "array", "description": "finance.yahoo.com/quote/... links, or a text/CSV file of them (\"Link remote text file\"). Same as putting them in Tickers.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search Yahoo Finance", "type": "array", "description": "Words to find symbols and headlines by, e.g. \"lithium\", \"semiconductor ETF\", \"vanguard\". Each match is a search-result row; headlines are news rows.", "items": { "type": "string" } }, "screeners": { "title": "Yahoo screeners and lists", "uniqueItems": true, "type": "array", "description": "Yahoo Finance's ranked lists. Each listed symbol becomes a ticker row with the sections you pick.", "items": { "type": "string", "enum": [ "day_gainers", "day_losers", "most_actives", "trending", "most_shorted_stocks", "undervalued_growth_stocks", "undervalued_large_caps", "growth_technology_stocks", "aggressive_small_caps", "small_cap_gainers", "strong_undervalued_stocks", "morningstar_five_star_stocks", "fifty_two_wk_gainers", "fifty_two_wk_losers", "most_watched_tickers", "portfolio_anchors", "solid_large_growth_funds", "solid_midcap_growth_funds", "conservative_foreign_funds", "high_yield_bond", "top_mutual_funds", "top_etfs_us", "top_performing_etfs", "technology_etfs", "bond_etfs", "all_cryptocurrencies_us", "day_gainers_cryptocurrencies", "day_losers_cryptocurrencies", "most_actives_cryptocurrencies", "top_options_open_interest" ], "enumTitles": [ "Day gainers", "Day losers", "Most active", "Trending tickers", "Most shorted stocks", "Undervalued growth stocks", "Undervalued large caps", "Growth technology stocks", "Aggressive small caps", "Small caps with momentum", "Strong undervalued stocks", "Morningstar 5-star stocks", "52-week gainers", "52-week losers", "Most added to watchlists", "Portfolio anchors (funds)", "Solid large growth funds", "Solid mid-cap growth funds", "Conservative foreign funds", "High-yield bond funds", "Top mutual funds", "Top ETFs (US)", "Top performing ETFs", "Technology ETFs", "Bond ETFs", "All cryptocurrencies", "Crypto day gainers", "Crypto day losers", "Most active crypto", "Highest options open interest" ] } }, "screenerRegion": { "title": "Market for gainers, losers and most active", "enum": [ "US", "GB", "CA", "AU", "DE", "FR", "IT", "ES", "NL", "CH", "SE", "IN", "HK", "JP", "KR", "TW", "SG", "BR", "MX", "ZA", "SA" ], "type": "string", "description": "Day gainers, day losers and most active for another market, by Yahoo's own criteria for its US lists. The other lists are US-only.", "default": "US" }, "trendingRegions": { "title": "Trending tickers in", "type": "array", "description": "Country codes for Yahoo's trending-tickers list, e.g. US, GB, DE, FR, CA, AU, IN, HK. Up to 100 symbols each.", "items": { "type": "string" } }, "marketSummary": { "title": "Market summary (major indices)", "type": "boolean", "description": "Add the indices, futures, rates and currencies Yahoo shows at the top of finance.yahoo.com (about 15 rows).", "default": false }, "maxDiscoveryResults": { "title": "Symbols per list", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many symbols to take from each screener or trending list, in Yahoo's order (screeners up to 1,000, trending up to 100).", "default": 25 }, "sections": { "title": "Data sections", "uniqueItems": true, "type": "array", "description": "Quote = price, change, volume, market cap, P/E, EPS, dividend, 52-week range, pre/post market. Each other section adds its data to the ticker row.", "items": { "type": "string", "enum": [ "quote", "profile", "statistics", "financials", "earnings", "analyst", "ownership", "insiders", "secFilings", "transcripts", "calendar", "insights", "similar", "news", "options", "history", "dividends", "technicals" ], "enumTitles": [ "Quote", "Profile (sector, industry, employees, officers, governance)", "Key statistics and financial data", "Financial statements (income, balance sheet, cash flow)", "Earnings (history, estimates, GAAP and non-GAAP)", "Analysts (recommendations, targets, upgrades/downgrades)", "Holders (institutions, funds, breakdown)", "Insiders (holders, transactions)", "SEC filings", "Earnings-call transcripts", "Calendar (next earnings, dividend dates)", "Insights (technical outlook, valuation, research)", "Similar symbols", "News", "Options chain", "Price history (OHLCV)", "Dividends and splits (all time)", "Technical indicators (SMA, RSI, MACD, returns)" ] }, "default": [ "quote", "profile", "statistics", "analyst", "earnings" ] }, "financialsPeriod": { "title": "Statements period", "enum": [ "annual", "quarterly", "trailing", "both", "all" ], "type": "string", "description": "Financial statements: annual (about 4 years), quarterly (5 quarters), trailing 12 months, or all three.", "default": "annual" }, "maxNewsPerTicker": { "title": "Headlines per ticker", "minimum": 0, "maximum": 60, "type": "integer", "description": "Latest Yahoo Finance headlines per ticker when News is on (Yahoo serves about 50).", "default": 10 }, "ratingChangesPerTicker": { "title": "Analyst rating changes per ticker", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Newest upgrades/downgrades to keep per ticker (Yahoo has hundreds for large US companies; 0 = none).", "default": 25 }, "secFilingsPerTicker": { "title": "SEC filings per ticker", "minimum": 0, "maximum": 500, "type": "integer", "description": "Newest SEC filings to keep per ticker (10-K, 10-Q, 8-K, proxy...).", "default": 20 }, "modules": { "title": "Extra quoteSummary modules", "type": "array", "description": "Advanced: any Yahoo quoteSummary module name added to each ticker row, e.g. earningsTrendGaap, fundPerformance, upgradeDowngradeHistoryLatest.", "items": { "type": "string" } }, "historyRange": { "title": "History period", "enum": [ "1d", "5d", "1mo", "3mo", "6mo", "ytd", "1y", "2y", "5y", "10y", "max", "all" ], "type": "string", "description": "How far back the bars go. \"Every bar since listing\" reads every daily bar Yahoo has (AAPL: 11,556 since 1980). Start and end dates override it.", "default": "1mo" }, "historyInterval": { "title": "Bar size", "enum": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1wk", "1mo", "3mo" ], "type": "string", "description": "Yahoo keeps 1-minute bars for about 30 days (we split them into its 7-day windows), 2-90 minute bars for 60 days, hourly for 2 years.", "default": "1d" }, "historyStartDate": { "title": "History start", "type": "string", "description": "Optional first day (YYYY-MM-DD) or a period back from today, e.g. \"30 days\", \"6 months\". Overrides the period." }, "historyEndDate": { "title": "History end", "type": "string", "description": "Optional last day, included. Empty = today." }, "historyFormat": { "title": "History format", "enum": [ "nested", "series", "rows" ], "type": "string", "description": "Inside the ticker row (bars list or column series), or one row per bar (charged per bar; handy for CSV and backtests).", "default": "nested" }, "includePrePost": { "title": "Pre- and after-market bars", "type": "boolean", "description": "Intraday bars only: add extended-hours bars; each bar says its session (pre, regular, post).", "default": false }, "adjustedPrices": { "title": "Adjust OHLC for splits and dividends", "type": "boolean", "description": "Scale open/high/low/close by the adjusted-close factor (total-return series). adjClose is always included on daily and longer bars.", "default": false }, "includeEvents": { "title": "Dividends and splits on bars", "type": "boolean", "description": "Bars carry the dividend amount or split ratio on the day it happened.", "default": true }, "maxBarsPerTicker": { "title": "Max bars per ticker", "minimum": 0, "type": "integer", "description": "Keep only the most recent N bars per ticker. 0 = all in the period.", "default": 0 }, "comparisons": { "title": "Compare with", "type": "array", "description": "Benchmark symbols whose closes come with each ticker's bars, e.g. ^GSPC, QQQ (up to 10).", "items": { "type": "string" } }, "optionExpirations": { "title": "Option expirations", "minimum": 0, "maximum": 100, "type": "integer", "description": "How many expiration dates to read, nearest first. 0 = all of them (SPY lists 30+).", "default": 1 }, "optionDates": { "title": "Only these expirations", "type": "array", "description": "Expiration dates (YYYY-MM-DD, e.g. 2026-12-18) instead of the nearest ones. Dates Yahoo does not list are named in requestedDatesNotListed.", "items": { "type": "string" } }, "optionMinDays": { "title": "Min days to expiration", "minimum": 0, "type": "integer", "description": "Skip expirations sooner than this." }, "optionMaxDays": { "title": "Max days to expiration", "minimum": 0, "type": "integer", "description": "Skip expirations later than this." }, "optionType": { "title": "Calls or puts", "enum": [ "both", "call", "put" ], "type": "string", "description": "Both, or only calls or only puts.", "default": "both" }, "optionMinStrike": { "title": "Min strike", "type": "number", "description": "Only strikes at or above this price." }, "optionMaxStrike": { "title": "Max strike", "type": "number", "description": "Only strikes at or below this price." }, "optionStrikeRangePercent": { "title": "Strikes within % of price", "minimum": 0, "maximum": 1000, "type": "number", "description": "Only strikes within this % of the underlying price (10 keeps 90-110%). 0 = all.", "default": 0 }, "optionStrikesAroundPrice": { "title": "Strikes around price", "minimum": 0, "maximum": 500, "type": "integer", "description": "Keep only the N strikes below and N above the current price in each expiration. 0 = all.", "default": 0 }, "optionMoneyness": { "title": "Moneyness", "enum": [ "all", "itm", "otm" ], "type": "string", "description": "All contracts, or only in-the-money / out-of-the-money ones.", "default": "all" }, "optionMinVolume": { "title": "Min volume", "minimum": 0, "type": "integer", "description": "Only contracts traded at least this many times today.", "default": 0 }, "optionMinOpenInterest": { "title": "Min open interest", "minimum": 0, "type": "integer", "description": "Only contracts with at least this open interest.", "default": 0 }, "optionMinImpliedVolatility": { "title": "Min implied volatility", "minimum": 0, "type": "number", "description": "Only contracts at or above this implied volatility (0.5 = 50%).", "default": 0 }, "includeGreeks": { "title": "Greeks", "type": "boolean", "description": "Delta, gamma, theta (per day), vega and rho (per point) and a theoretical price by Black-Scholes-Merton, with the 13-week T-bill rate and the dividend yield.", "default": true }, "optionsFormat": { "title": "Options format", "enum": [ "nested", "rows" ], "type": "string", "description": "Chains inside the ticker row, or one row per contract (charged per contract).", "default": "nested" }, "maxOptionContracts": { "title": "Max contracts per ticker", "minimum": 0, "type": "integer", "description": "Stop after this many contracts per ticker. 0 = no limit.", "default": 0 }, "searchType": { "title": "Search for", "enum": [ "all", "equity", "etf", "mutualfund", "index", "future", "currency", "cryptocurrency" ], "type": "string", "description": "Which kind of symbols the search returns.", "default": "all" }, "maxSymbolsPerQuery": { "title": "Symbols per search", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Search-result rows per search (up to 1,000; past the first few, Yahoo's symbol lookup is paged in).", "default": 10 }, "maxNewsPerQuery": { "title": "Headlines per search", "minimum": 0, "maximum": 50, "type": "integer", "description": "News rows per search (0 = none, Yahoo serves up to about 50).", "default": 10 }, "scrapeSearchMatches": { "title": "Also scrape the best match", "type": "boolean", "description": "Adds each search's best symbol to the tickers, so \"apple\" also gets you AAPL's ticker row.", "default": false }, "includeArticleText": { "title": "Full article text", "type": "boolean", "description": "Read each headline's article on finance.yahoo.com and add its full text. Partner sites outside Yahoo are marked external, not charged.", "default": false }, "includeTranscriptText": { "title": "Earnings-call transcript text", "type": "boolean", "description": "Add the full earnings-call transcript (speaker, role, time and text of every turn) to the newest transcripts. Turns on the Transcripts section.", "default": false }, "transcriptsPerTicker": { "title": "Transcripts per ticker", "minimum": 0, "maximum": 200, "type": "integer", "description": "Newest earnings-call transcripts to list per ticker (Yahoo lists up to ~60 for large US companies).", "default": 8 }, "maxTranscriptTexts": { "title": "Transcripts with text", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many of the newest transcripts per ticker get their full text.", "default": 1 }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Remember what earlier runs delivered: new headlines, filings, rating changes, insider trades and transcripts only, plus previousPrice and changeSinceLastRunPercent on every ticker.", "default": false }, "monitorStoreName": { "title": "Monitor store", "type": "string", "description": "Named key-value store that keeps the memory between runs.", "default": "yahoo-finance-monitor" }, "monitorKey": { "title": "Watch name", "type": "string", "description": "Optional name for this watch, so several schedules with the same tickers stay separate. Empty = derived from the input." }, "sinceDate": { "title": "Only items since", "type": "string", "description": "Keep only headlines, filings, rating changes, insider trades and transcripts dated on or after this day, e.g. 2026-10-01 or \"7 days\"." }, "onlyMovers": { "title": "Only tickers that moved", "type": "boolean", "description": "Deliver a ticker only when it moved at least the threshold (since the last delivered run in monitor mode, else today). A run with no mover delivers and bills nothing.", "default": false }, "alertThresholdPercent": { "title": "Move threshold (%)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Absolute % move that makes a ticker a mover, e.g. 5.", "default": 5 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional: we POST a JSON summary (counts, movers, dataset id) here when a run delivers anything." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Optional: your bot's token, to get a message when a run delivers anything." }, "telegramChatId": { "title": "Telegram chat id", "type": "string", "description": "The chat the bot writes to." }, "layout": { "title": "Row layout", "enum": [ "yahoo", "yfinance" ], "type": "string", "description": "Yahoo's own field names, or the yfinance-style blocks (stock_info, price_info, history, financials, dividends, splits, news, recommendations, holders, options, earnings).", "default": "yahoo" }, "newsFormat": { "title": "News format", "enum": [ "nested", "rows" ], "type": "string", "description": "Headlines inside the ticker row, or one row per headline (charged per headline).", "default": "nested" }, "sectionsAsRows": { "title": "Section records as rows", "type": "boolean", "description": "One row per statement period, holder, insider trade, rating change, earnings quarter, estimate, SEC filing and transcript (charged per record) instead of lists inside the ticker row.", "default": false }, "compactOutput": { "title": "Compact ticker rows", "type": "boolean", "description": "Only the ~40 main quote and headline fields: small rows for AI agents, MCP and quick looks.", "default": false }, "maxItems": { "title": "Max rows", "minimum": 0, "type": "integer", "description": "Hard cap on all rows of the run (tickers + bars + contracts + headlines + records + search results); also caps your cost. 0 = no limit.", "default": 0 }, "lang": { "title": "Language", "type": "string", "description": "Language of names and news, e.g. en-US, en-GB, de-DE, fr-FR, ja-JP, zh-Hant-HK.", "default": "en-US" }, "region": { "title": "Region", "type": "string", "description": "Yahoo market region for names and news, e.g. US, GB, DE, JP, HK, AU, CA.", "default": "US" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed: Yahoo answers directly. If it slows a run down, the actor moves to Apify's datacenter proxy by itself, then to residential within a small budget.", "default": { "useApifyProxy": false } }, "maxConcurrency": { "title": "Tickers in parallel", "minimum": 1, "maximum": 32, "type": "integer", "description": "How many tickers are read at once.", "default": 8 }, "maxRunSeconds": { "title": "Max run time (s)", "minimum": 0, "type": "integer", "description": "Stop starting new tickers after this many seconds and finish cleanly. 0 = the run's own timeout.", "default": 0 } } }, "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 } } } } } } } } } }