{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Scraper — Quotes, History, Financials & News", "description": "Yahoo Finance data for stocks, ETFs, indices, crypto, FX and futures: quotes, price history, profiles, key stats, financial statements, analyst targets, earnings, news, screeners and ticker search.", "version": "0.1", "x-build-id": "2yMXEZikUPpwe04Oh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~yahoo-finance-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~yahoo-finance-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~yahoo-finance-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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 symbols or quote URLs, one per line: stocks (AAPL, BRK-B, SAP.DE, 7203.T), ETFs (SPY), indices (^GSPC), crypto (BTC-USD), currencies (EURUSD=X), futures (GC=F), mutual funds (VFIAX). Each ticker is one result with the sections chosen below.", "items": { "type": "string" } }, "includeQuote": { "title": "Quote", "type": "boolean", "description": "Price, change, volume, market cap, 52-week range, P/E, EPS, dividend, bid/ask, pre/post-market. Fetched in batches of 50 tickers.", "default": true }, "includeProfile": { "title": "Company profile", "type": "boolean", "description": "Sector, industry, employees, description, address, website and officers as Yahoo lists them; fund family, expense ratio and top holdings for ETFs/funds; coin info for crypto.", "default": true }, "includeStatistics": { "title": "Key statistics", "type": "boolean", "description": "Valuation (enterprise value, P/S, PEG, EV/EBITDA), margins, returns, cash and debt, short interest, ownership, beta, dividend and split details, fiscal dates.", "default": true }, "includeAnalysts": { "title": "Analyst ratings and price targets", "type": "boolean", "description": "Recommendation, mean/high/low price targets, rating trend for the last 4 months, the 25 latest upgrades/downgrades, EPS and revenue estimates.", "default": true }, "includeEarnings": { "title": "Earnings", "type": "boolean", "description": "Next earnings date with EPS and revenue estimates, EPS actual vs estimate for the last 4 quarters, yearly and quarterly revenue and earnings.", "default": true }, "includeFinancials": { "title": "Financial statements", "type": "boolean", "description": "Income statement, balance sheet and cash flow with all line items Yahoo shows (about 4 years or 5 quarters). Stocks only.", "default": false }, "financialsPeriod": { "title": "Financial statements period", "enum": [ "annual", "quarterly", "both" ], "type": "string", "description": "Annual, quarterly or both (both = 2 requests per ticker).", "default": "annual" }, "includeHistory": { "title": "Historical prices", "type": "boolean", "description": "Open, high, low, close, adjusted close and volume per bar for the date range below, plus dividends and splits in that range.", "default": false }, "historyStart": { "title": "History from", "type": "string", "description": "Start date YYYY-MM-DD, or a period back from today: '1 year', '6 months', '30 days', 'ytd', 'max'. Intraday bars only go back as far as Yahoo keeps them (1m: 7 days, 5m-30m: 60 days, 1h: 2 years).", "default": "1 year" }, "historyEnd": { "title": "History to", "type": "string", "description": "End date YYYY-MM-DD (included). Empty = today." }, "historyInterval": { "title": "Interval", "enum": [ "1d", "1wk", "1mo", "1h", "30m", "15m", "5m", "1m" ], "type": "string", "description": "Bar size.", "default": "1d" }, "historyAsRows": { "title": "One row per price bar", "type": "boolean", "description": "Output every bar as its own result (type 'priceBar', with dividend/split on the bar they fall in), handy for CSV/Excel and backtests. Each bar is then one result. Off: the bars are a 'history' list inside the ticker result.", "default": false }, "includeNews": { "title": "News headlines", "type": "boolean", "description": "Latest Yahoo Finance headlines per ticker: title, publisher, link, time, related tickers. Each headline is one result (a headline found for several tickers is output once).", "default": false }, "maxNewsPerTicker": { "title": "Headlines per ticker", "minimum": 1, "maximum": 50, "type": "integer", "description": "1-50 (Yahoo returns at most about 50).", "default": 10 }, "lists": { "title": "Market lists", "type": "array", "description": "Lists as on finance.yahoo.com/markets: most active, gainers, losers, trending, 52-week movers, screeners for stocks, ETFs, funds and crypto. Each listed security is one result with its quote.", "items": { "type": "string", "enum": [ "most_actives", "day_gainers", "day_losers", "trending", "most_watched_tickers", "fifty_two_wk_gainers", "fifty_two_wk_losers", "undervalued_growth_stocks", "growth_technology_stocks", "undervalued_large_caps", "aggressive_small_caps", "small_cap_gainers", "most_shorted_stocks", "top_etfs_us", "most_actives_etfs", "top_mutual_funds", "all_cryptocurrencies_us", "most_actives_cryptocurrencies", "day_gainers_cryptocurrencies", "day_gainers_europe" ], "enumTitles": [ "Most active stocks", "Top gainers", "Top losers", "Trending tickers (US)", "Most added to watchlists", "52-week gainers", "52-week losers", "Undervalued growth stocks", "Growth technology stocks", "Undervalued large caps", "Aggressive small caps", "Small caps with momentum", "Most shorted stocks", "Top ETFs (US)", "Most active ETFs", "Top mutual funds", "All cryptocurrencies", "Most active cryptocurrencies", "Top crypto gainers", "Top gainers (Europe)" ] } }, "maxResultsPerList": { "title": "Results per list", "minimum": 1, "type": "integer", "description": "Take at most this many entries from each list, in Yahoo's order (250 per request).", "default": 25 }, "searchQueries": { "title": "Ticker search", "type": "array", "description": "Company names or keywords to look up symbols for, e.g. 'apple', 'nvidia', 'gold'. Each match is one result: symbol, name, exchange, type, sector, industry.", "items": { "type": "string" } }, "maxSearchResults": { "title": "Matches per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "1-20.", "default": 10 }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this search returned and output only new items or items whose price/status changed. Use with a Schedule; unchanged items are not charged. Here: news headlines are output once, when they first appear. Ticker results, list rows and search results are always output.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input." }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many results in total (tickers + headlines + list rows + search results + price bars). Keeps cost predictable.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy works and is the cheapest; each IP gets its own Yahoo cookie and crumb, and throttled IPs are replaced automatically. If datacenter IPs keep getting throttled, the run switches to RESIDENTIAL when your plan has it.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }