{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Market Data & Fundamentals Scraper", "description": "Pull live quotes, historical OHLCV candles, financial statements, dividends, splits, news, analyst ratings and holder data from Yahoo Finance for any ticker, ETF, index, currency pair or crypto symbol.", "version": "1.0", "x-build-id": "z23J6rGwf21tmdpCT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~yahoo-finance-market-data-and-fundamentals-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-yahoo-finance-market-data-and-fundamentals-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/nimbryxo-studio~yahoo-finance-market-data-and-fundamentals-scraper/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-yahoo-finance-market-data-and-fundamentals-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/nimbryxo-studio~yahoo-finance-market-data-and-fundamentals-scraper/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-yahoo-finance-market-data-and-fundamentals-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "tickers", "search", "screener", "customScreener", "trending", "marketSummary" ], "type": "string", "description": "What to scrape.", "default": "tickers" }, "tickers": { "title": "Tickers", "type": "array", "description": "Symbols or Yahoo Finance quote URLs (mode=tickers). Examples: `AAPL`, `BRK.B`, `^GSPC`, `EURUSD=X`, `BTC-USD`, `7203.T`, `https://finance.yahoo.com/quote/AAPL/`.", "default": [], "items": { "type": "string" } }, "searchQuery": { "title": "Search query", "type": "string", "description": "Company, fund, index, currency or crypto name to search for (mode=search)." }, "maxSearchResults": { "title": "Max search results", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of search results to return (mode=search).", "default": 10 }, "screenerId": { "title": "Screener", "enum": [ "day_gainers", "day_losers", "most_actives", "most_shorted_stocks", "undervalued_growth_stocks", "growth_technology_stocks", "aggressive_small_caps", "small_cap_gainers", "all_cryptocurrencies_us", "day_gainers_cryptocurrencies", "day_losers_cryptocurrencies", "most_actives_cryptocurrencies", "highest_valuation_private_company", "recently_funded_private_company", "most_funded_private_company", "top_mutual_funds", "day_gainers_mutual_funds", "portfolio_anchors", "solid_large_growth_funds", "solid_midcap_growth_funds", "conservative_foreign_funds", "high_yield_bond" ], "type": "string", "description": "Yahoo predefined screener to run (mode=screener). Predefined screeners are US-centric; use mode=customScreener for a region-aware list.", "default": "day_gainers" }, "screenerSort": { "title": "Custom screener sort", "enum": [ "intradaymarketcap", "percentchange", "dayvolume" ], "type": "string", "description": "Sort field for mode=customScreener.", "default": "intradaymarketcap" }, "region": { "title": "Region", "enum": [ "US", "GB", "DE", "FR", "JP", "HK", "IN", "CA", "AU", "BR", "CN", "KR", "TW", "SG", "CH", "NL", "ES", "IT", "SE", "NO", "DK", "FI", "BE", "AT", "IE", "NZ", "ZA", "MX", "AR", "CL", "PE" ], "type": "string", "description": "Yahoo market region used for quotes, search, trending, localization and mode=customScreener.", "default": "US" }, "language": { "title": "Language", "enum": [ "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "nl-NL", "pt-BR", "ja-JP", "zh-Hant-HK", "zh-Hans-CN", "ko-KR", "ru-RU", "ar-SA", "hi-IN", "tr-TR", "pl-PL", "sv-SE", "da-DK", "fi-FI", "no-NO" ], "type": "string", "description": "Language used for names, news and localized labels.", "default": "en-US" }, "range": { "title": "Chart range", "enum": [ "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max" ], "type": "string", "description": "History range used when no start/end dates are supplied (mode=tickers).", "default": "1mo" }, "startDate": { "title": "History start date", "type": "string", "description": "Earliest date for historical bars (`YYYY-MM-DD`). Overrides `range` (mode=tickers)." }, "endDate": { "title": "History end date", "type": "string", "description": "Latest date for historical bars (`YYYY-MM-DD`). Overrides `range` (mode=tickers)." }, "interval": { "title": "Chart interval", "enum": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1wk", "1mo", "3mo" ], "type": "string", "description": "Candle interval. Intraday intervals have shorter Yahoo range limits; incompatible combinations are clamped and reported in the run status.", "default": "1d" }, "includePrePost": { "title": "Include pre/post market bars", "type": "boolean", "description": "Include extended-hours bars for intraday history.", "default": false }, "includeHistory": { "title": "Include OHLCV history", "type": "boolean", "description": "Include historical bars with adjusted close.", "default": true }, "includeDividends": { "title": "Include dividends", "type": "boolean", "description": "Include the full dividend history from Yahoo chart events.", "default": true }, "includeSplits": { "title": "Include splits", "type": "boolean", "description": "Include stock-split history with numerator and denominator.", "default": true }, "includeNews": { "title": "Include news", "type": "boolean", "description": "Include ticker-related news headlines.", "default": true }, "maxNews": { "title": "Max news items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum news items per ticker. Yahoo's news graph serves 200+ items through cursor pagination; the actor caps this request at 200.", "default": 25 }, "includeFinancials": { "title": "Include annual financials", "type": "boolean", "description": "Include annual income statement, balance sheet and cash-flow statement.", "default": false }, "includeQuarterlyFinancials": { "title": "Include quarterly financials", "type": "boolean", "description": "Add quarterly statements under `financials.quarterly`. Takes effect only when `includeFinancials` is also on.", "default": false }, "includeHolders": { "title": "Include holders", "type": "boolean", "description": "Include institutional, mutual-fund, major-holder and insider-holder summaries.", "default": false }, "includeInsiders": { "title": "Include insider activity", "type": "boolean", "description": "Include insider transactions, insider holders and net share-purchase activity.", "default": false }, "includeOptions": { "title": "Include options chain", "type": "boolean", "description": "Include option chains for optionable symbols.", "default": false }, "optionExpirations": { "title": "Option expirations", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many upcoming option expirations to fetch (mode=tickers, includeOptions=true).", "default": 1 }, "maxOptionContracts": { "title": "Max contracts per side", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum calls and maximum puts per expiration.", "default": 50 }, "optionContractType": { "title": "Option contract type", "enum": [ "both", "calls", "puts" ], "type": "string", "description": "Which option sides to return.", "default": "both" }, "minStrike": { "title": "Minimum strike", "minimum": 0, "maximum": 1000000000, "type": "number", "description": "Drop option contracts below this strike." }, "maxStrike": { "title": "Maximum strike", "minimum": 0, "maximum": 1000000000, "type": "number", "description": "Drop option contracts above this strike." }, "minVolume": { "title": "Minimum option volume", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Drop option contracts below this volume. Contracts with no volume are excluded when this is set." }, "minOpenInterest": { "title": "Minimum open interest", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Drop option contracts below this open interest. Contracts with no open interest are excluded when this is set." }, "minImpliedVolatilityPercent": { "title": "Minimum implied volatility (%)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Drop contracts below this implied volatility in percent, e.g. 25 means 25%." }, "includeRecommendations": { "title": "Include recommendations", "type": "boolean", "description": "Include the analyst recommendation summary and four-period recommendation trend.", "default": true }, "includeUpgradesDowngrades": { "title": "Include upgrades and downgrades", "type": "boolean", "description": "Include the latest analyst rating changes.", "default": false }, "includeAnalystPriceTargets": { "title": "Include price targets", "type": "boolean", "description": "Include the analyst price-target summary.", "default": true }, "includeEarningsHistory": { "title": "Include earnings history", "type": "boolean", "description": "Include recent quarters with EPS actual, estimate, difference and surprise.", "default": true }, "includeEarningsEstimates": { "title": "Include earnings estimates", "type": "boolean", "description": "Include EPS and revenue estimates plus growth estimates.", "default": false }, "includeEarningsCalendar": { "title": "Include earnings calendar", "type": "boolean", "description": "Include upcoming earnings dates, estimates and dividend dates.", "default": true }, "includeFundData": { "title": "Include fund data", "type": "boolean", "description": "Include fund profile, top holdings and performance for ETFs and mutual funds.", "default": false }, "includeSecFilings": { "title": "Include SEC filings", "type": "boolean", "description": "Include recent SEC filings with EDGAR links and exhibits.", "default": false }, "includeInsights": { "title": "Include analyst insights", "type": "boolean", "description": "Include technical outlook, research reports and significant developments.", "default": false }, "includeRelatedSymbols": { "title": "Include related symbols", "type": "boolean", "description": "Include Yahoo's related-symbol recommendations.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum records for screener, customScreener, trending and marketSummary modes. Search uses maxSearchResults.", "default": 50 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of tickers fetched in parallel (mode=tickers).", "default": 4 } } }, "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 } } } } } } } } } }