{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Scraper - Quotes, Fundamentals, Options & News", "description": "Extract Yahoo Finance data: live quotes, historical OHLCV candles, fundamentals, analyst ratings, options chains, news, ticker search, and screeners. Export JSON, CSV, Excel via API.", "version": "1.0", "x-build-id": "Qcc0vrVz6SQWWJhxb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~yahoo-finance-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-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/parsebird~yahoo-finance-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-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/parsebird~yahoo-finance-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-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", "required": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "quotes", "historical", "fundamentals", "analysis", "options", "news", "search", "screener" ], "type": "string", "description": "What to fetch from Yahoo Finance.", "default": "quotes" }, "tickers": { "title": "Tickers", "type": "array", "description": "Stock, ETF, index, or crypto symbols (e.g. AAPL, ^GSPC, BTC-USD) or full Yahoo Finance quote URLs. Required for quotes, historical, fundamentals, analysis, and options. Optional for news (used as the search query per ticker).", "items": { "type": "string" }, "default": [ "AAPL", "MSFT", "BTC-USD", "^GSPC" ] }, "query": { "title": "Search Query", "type": "string", "description": "Free text used for the search operation, or as a fallback query for news when Tickers is empty.", "default": "" }, "range": { "title": "Range", "enum": [ "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max" ], "type": "string", "description": "Historical lookback window. Ignored when Start Date / End Date are set.", "default": "1mo" }, "interval": { "title": "Interval", "enum": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1wk", "1mo", "3mo" ], "type": "string", "description": "Candle size for the historical operation.", "default": "1d" }, "startDate": { "title": "Start Date", "type": "string", "description": "Explicit start date (YYYY-MM-DD). Overrides Range when set together with End Date.", "default": "" }, "endDate": { "title": "End Date", "type": "string", "description": "Explicit end date (YYYY-MM-DD). Overrides Range when set together with Start Date.", "default": "" }, "includeEvents": { "title": "Include Dividends & Splits", "type": "boolean", "description": "Emit extra dividend and split rows alongside historical candles.", "default": false }, "optionsExpirations": { "title": "Options Expirations", "minimum": 1, "maximum": 12, "type": "integer", "description": "Number of upcoming expiration dates to pull per ticker for the options operation.", "default": 1 }, "screenerId": { "title": "Screener", "enum": [ "day_gainers", "day_losers", "most_actives", "growth_technology_stocks", "undervalued_large_caps", "undervalued_growth_stocks", "aggressive_small_caps", "small_cap_gainers", "top_mutual_funds", "conservative_foreign_funds", "high_yield_bond", "portfolio_anchors", "solid_large_growth_funds", "solid_midcap_growth_funds" ], "type": "string", "description": "Predefined Yahoo Finance screener to pull for the screener operation.", "default": "day_gainers" }, "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Hard cap on the number of rows returned for the run. Leave empty for no cap." }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Yahoo Finance rate-limits datacenter IPs. Residential Apify Proxy is used by default; override only if you have your own proxy group.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }