{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Scraper - Quotes, History, Options, Fundamentals", "description": "Yahoo Finance scraper: live quotes, OHLCV price history, fundamentals and financial statements, options chains, predefined screeners (gainers, most active) and ticker news. Pick the modes you need. From US$0.50 per 1,000 records.", "version": "0.1", "x-build-id": "BWkWKG9xF2Mvf7NWV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~yahoo-finance-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-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/fabrikit~yahoo-finance-scraper/runs": { "post": { "operationId": "runs-sync-fabrikit-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/fabrikit~yahoo-finance-scraper/run-sync": { "post": { "operationId": "run-sync-fabrikit-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": { "modes": { "title": "Data to collect (modes)", "type": "array", "description": "Choose one or more. quotes = live quote per symbol; history = OHLCV bars (+ dividends and splits); summary = fundamentals modules (valuation, profile, analyst targets, earnings...); financials = income statement, balance sheet and cash-flow figures per period; options = option chain contracts; screener = Yahoo predefined screeners (no symbols needed); news = latest news per symbol.", "items": { "type": "string", "enum": [ "quotes", "history", "summary", "financials", "options", "screener", "news" ], "enumTitles": [ "Quotes", "Historical prices", "Fundamentals summary", "Financial statements", "Options chain", "Screeners", "News" ] }, "default": [ "quotes", "history" ] }, "symbols": { "title": "Ticker symbols", "type": "array", "description": "Yahoo Finance symbols: stocks (AAPL), ETFs (SPY), indices (^GSPC), crypto (BTC-USD), forex (EURUSD=X), futures (GC=F), non-US listings (SAP.DE, 7203.T). Not needed for the screener mode.", "default": [ "AAPL", "MSFT", "NVDA" ], "items": { "type": "string" } }, "range": { "title": "History: range", "enum": [ "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max" ], "type": "string", "description": "How far back to go for price history. Ignored when a start or end date is set.", "default": "5d" }, "interval": { "title": "History: bar interval", "enum": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1wk", "1mo", "3mo" ], "type": "string", "description": "Size of each price bar. Intraday intervals are limited by Yahoo (1m = last 8 days per request, other intraday = last 60 days).", "default": "1d" }, "startDate": { "title": "History: start date (YYYY-MM-DD)", "type": "string", "description": "Optional. Overrides the range." }, "endDate": { "title": "History: end date (YYYY-MM-DD)", "type": "string", "description": "Optional. Defaults to now." }, "includeEvents": { "title": "History: include dividends and splits", "type": "boolean", "description": "Adds one extra record per dividend payment and stock split in the period (recordType dividend / split).", "default": true }, "summaryModules": { "title": "Summary: Yahoo modules", "type": "array", "description": "Fundamentals modules to fetch in the summary mode. Company officers are never exported.", "items": { "type": "string", "enum": [ "price", "summaryDetail", "defaultKeyStatistics", "financialData", "assetProfile", "summaryProfile", "earnings", "earningsTrend", "earningsHistory", "calendarEvents", "recommendationTrend", "upgradeDowngradeHistory", "majorHoldersBreakdown", "institutionOwnership", "fundOwnership", "netSharePurchaseActivity", "secFilings", "indexTrend", "industryTrend", "sectorTrend", "incomeStatementHistory", "incomeStatementHistoryQuarterly", "balanceSheetHistory", "balanceSheetHistoryQuarterly", "cashflowStatementHistory", "cashflowStatementHistoryQuarterly", "fundProfile", "topHoldings", "quoteType" ] }, "default": [ "price", "summaryDetail", "defaultKeyStatistics", "financialData", "assetProfile", "earnings", "calendarEvents", "recommendationTrend" ] }, "financialsPeriod": { "title": "Financial statements: period", "enum": [ "annual", "quarterly", "both" ], "type": "string", "description": "Annual, quarterly or both. One record per symbol and fiscal period with revenue, gross profit, operating income, EBITDA, net income, EPS, assets, liabilities, equity, cash, debt and cash flows.", "default": "annual" }, "maxExpirations": { "title": "Options: number of expirations", "minimum": 1, "maximum": 60, "type": "integer", "description": "Nearest expiration dates to fetch per symbol. Each expiration holds dozens to hundreds of contracts (one record each).", "default": 1 }, "optionType": { "title": "Options: contract type", "enum": [ "all", "calls", "puts" ], "type": "string", "description": "Keep calls, puts or both.", "default": "all" }, "screeners": { "title": "Screeners: predefined lists", "type": "array", "description": "Yahoo predefined screeners used by the screener mode.", "items": { "type": "string", "enum": [ "day_gainers", "day_losers", "most_actives", "undervalued_growth_stocks", "growth_technology_stocks", "undervalued_large_caps", "aggressive_small_caps", "small_cap_gainers", "most_shorted_stocks", "top_mutual_funds", "conservative_foreign_funds", "portfolio_anchors", "solid_large_growth_funds", "solid_midcap_growth_funds", "high_yield_bond", "top_etfs_us" ] }, "default": [ "day_gainers" ] }, "maxItemsPerScreener": { "title": "Screeners: max items per list", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum rows from each predefined screener.", "default": 25 }, "newsPerSymbol": { "title": "News: articles per symbol", "minimum": 1, "maximum": 50, "type": "integer", "description": "Latest news articles per symbol in the news mode.", "default": 10 }, "maxItems": { "title": "Max records in total", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Hard cap for the whole run across all modes. Each record is billed once.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Datacenter proxy is tried first. If Yahoo rate-limits or blocks it, the Actor automatically switches to a US residential proxy for the rest of the run.", "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 } } } } } } } } } }