{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Scraper: Quotes, Analyst Targets & Alerts", "description": "Export Yahoo Finance data for stocks, ETFs, indices, crypto, currencies and futures: price, valuation ratios, dividends, next earnings date, analyst rating and price targets, latest analyst actions, daily price history. Monitoring mode returns only what changed since the last run.", "version": "0.1", "x-build-id": "oxhrXebAkqbbRwHab" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datasmithlab~yahoo-finance-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datasmithlab-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/datasmithlab~yahoo-finance-scraper/runs": { "post": { "operationId": "runs-sync-datasmithlab-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/datasmithlab~yahoo-finance-scraper/run-sync": { "post": { "operationId": "run-sync-datasmithlab-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": [ "symbols" ], "properties": { "symbols": { "title": "Ticker symbols", "type": "array", "description": "One per line, as on Yahoo Finance: stocks (AAPL, 0700.HK, BRK-B), ETFs (SPY), indices (^GSPC), crypto (BTC-USD), currencies (EURUSD=X), futures (ES=F). Up to 500 per run.", "items": { "type": "string" } }, "includeHistory": { "title": "Add daily price history", "type": "boolean", "description": "Adds one row per trading day for about the last year (open, high, low, close, adjusted close, volume, dividends, splits) for every symbol. Billed per price-bar row.", "default": false }, "onlyChanges": { "title": "Only changes (monitoring mode)", "type": "boolean", "description": "Schedule the Actor and every later run returns only symbols that are new or whose analyst rating, average price target, analyst count, next earnings date, dividend or latest analyst action changed. Unchanged symbols are not returned and not charged. With price history on, only trading days after the last run are added.", "default": false }, "alertDayMovePct": { "title": "Also alert on a day move of at least (%)", "minimum": 0.1, "type": "number", "description": "Monitoring mode only: also return a symbol (changeType MOVE) when its price moved at least this many percent on the day, e.g. 5. Leave empty to ignore price moves." }, "maxItems": { "title": "Max rows", "minimum": 1, "type": "integer", "description": "Stop after this many rows in total (quote rows and price bars; you pay per row).", "default": 1000 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Requests go out without a proxy first. Only if Yahoo Finance blocks them (or asks for cookie consent from a non-US address) is this proxy used (at most 3 new IPs, then the run stops and reports 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 } } } } } } } } } }