{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Market Data API", "description": "Fast Yahoo Finance scraper for quotes, history, fundamentals, news, options, holders, recommendations, dividends, splits, and earnings.", "version": "0.0", "x-build-id": "kPQ0xMX9Y3pvqB0Q5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/philzx~yahoo-finance-market-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-philzx-yahoo-finance-market-data", "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/philzx~yahoo-finance-market-data/runs": { "post": { "operationId": "runs-sync-philzx-yahoo-finance-market-data", "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/philzx~yahoo-finance-market-data/run-sync": { "post": { "operationId": "run-sync-philzx-yahoo-finance-market-data", "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": [ "tickers" ], "properties": { "tickers": { "title": "Tickers", "type": "array", "description": "Ticker symbols to fetch. Examples: AAPL, MSFT, TSLA, BTC-USD, EURUSD=X, ^GSPC.", "items": { "type": "string" } }, "start_date": { "title": "Start date", "type": "string", "description": "Optional start date for historical candles in YYYY-MM-DD format. If provided, overrides period.", "default": "" }, "end_date": { "title": "End date", "type": "string", "description": "Optional end date for historical candles in YYYY-MM-DD format.", "default": "" }, "period": { "title": "History period", "enum": [ "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max" ], "type": "string", "description": "Historical range when start_date is empty.", "default": "1y" }, "interval": { "title": "History interval", "enum": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1wk", "1mo", "3mo" ], "type": "string", "description": "Historical candle interval. Intraday intervals are limited by Yahoo Finance availability.", "default": "1d" }, "includeHistory": { "title": "Include historical prices", "type": "boolean", "description": "Include OHLCV historical candles.", "default": true }, "includeFinancials": { "title": "Include financial statements", "type": "boolean", "description": "Include income statement, balance sheet, and cash flow.", "default": true }, "includeDividends": { "title": "Include dividends", "type": "boolean", "description": "Include dividend history.", "default": true }, "includeSplits": { "title": "Include splits", "type": "boolean", "description": "Include stock split history.", "default": true }, "includeNews": { "title": "Include news", "type": "boolean", "description": "Include latest Yahoo Finance news for each ticker.", "default": true }, "maxNews": { "title": "Max news items", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum news articles per ticker.", "default": 10 }, "includeRecommendations": { "title": "Include analyst recommendations", "type": "boolean", "description": "Include analyst recommendation trends and upgrades/downgrades when available.", "default": true }, "includeHolders": { "title": "Include holders", "type": "boolean", "description": "Include major and institutional holders when available.", "default": true }, "includeOptions": { "title": "Include options chain", "type": "boolean", "description": "Include options calls/puts for the first N expirations.", "default": true }, "maxOptionExpirations": { "title": "Max option expirations", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum option expiration dates to fetch per ticker. Use 0 to return only the expiration list.", "default": 1 }, "includeEarnings": { "title": "Include earnings", "type": "boolean", "description": "Include earnings dates and earnings-related tables when available.", "default": true }, "maxRowsPerTable": { "title": "Max rows per table", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Safety limit for large nested tables such as history, news, recommendations, holders, and options. 0 means no limit.", "default": 500 } } }, "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 } } }, "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 } } } } } } } } } }