{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Scraper (Quotes, Fundamentals, History)", "description": "Yahoo Finance Scraper SD - Yahoo Finance Scraper is a market data tool that extracts real-time quotes, company profiles and key statistics (quoteSummary modules), daily or intraday price history, ticker news with full text and screener lists (gainers, losers, most active) from Yahoo Finance.", "version": "1.0", "x-build-id": "YhIMb5NPPensFXVDm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~yahoo-finance-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-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/neuro-scraper~yahoo-finance-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-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/neuro-scraper~yahoo-finance-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-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": { "mode": { "title": "What to scrape", "enum": [ "quotes", "history", "news", "screener" ], "type": "string", "description": "quotes = one row per ticker with price, change, volume, market cap, P/E ... plus the quoteSummary modules you pick; history = one row per price bar (daily or intraday); news = the latest Yahoo Finance news for each ticker; screener = Yahoo's predefined screeners (day gainers, most actives ...).", "default": "quotes" }, "tickers": { "title": "Tickers", "type": "array", "description": "Yahoo Finance symbols or quote links: AAPL, MSFT, BRK-B, ^GSPC (index), BTC-USD (crypto), EURUSD=X (forex), GC=F (futures), 7203.T (Tokyo), https://finance.yahoo.com/quote/TSLA/.", "items": { "type": "string" } }, "summaryModules": { "title": "quoteSummary modules (quotes mode)", "type": "array", "description": "Extra company data per ticker, one request per ticker: assetProfile (sector, industry, employees, officers, website, address), financialData (margins, cash, debt, analyst targets), defaultKeyStatistics, summaryDetail, price, calendarEvents, earnings, recommendationTrend, incomeStatementHistory, balanceSheetHistory, cashflowStatementHistory, majorHoldersBreakdown, insiderHolders, upgradeDowngradeHistory. Empty = quote only.", "default": [ "assetProfile", "financialData", "defaultKeyStatistics", "summaryDetail" ], "items": { "type": "string" } }, "historyInterval": { "title": "Bar interval (history mode)", "enum": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1wk", "1mo", "3mo" ], "type": "string", "description": "Daily, weekly or monthly bars cover the full history. Intraday bars are limited by Yahoo (1m: last 30 days, read in 8-day windows; 2m-90m: last 60 days).", "default": "1d" }, "historyRange": { "title": "Period (history mode)", "enum": [ "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max" ], "type": "string", "description": "How far back, used when no start date is given. max = the whole listing history.", "default": "1mo" }, "startDate": { "title": "Start date (history mode)", "type": "string", "description": "YYYY-MM-DD. Overrides the period." }, "endDate": { "title": "End date (history mode)", "type": "string", "description": "YYYY-MM-DD. Empty = today." }, "includeArticleText": { "title": "Full article text (news mode)", "type": "boolean", "description": "Also open each finance.yahoo.com article and return its text and author (one extra request per article). Articles hosted on publisher sites keep only the headline and link.", "default": false }, "screenerIds": { "title": "Screener ids (screener mode)", "type": "array", "description": "Yahoo predefined screeners, e.g. day_gainers, day_losers, most_actives, undervalued_growth_stocks, growth_technology_stocks, aggressive_small_caps, small_cap_gainers, most_shorted_stocks, undervalued_large_caps.", "items": { "type": "string" } }, "maxItems": { "title": "Max rows per ticker / screener", "minimum": 1, "maximum": 100000, "type": "integer", "description": "history: newest bars kept per ticker; news: articles per ticker (Yahoo returns about 46 at most); screener: rows per screener. quotes mode always returns one row per ticker.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy in the US is the default: EU exits get Yahoo's cookie-consent page instead of data.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }