{ "openapi": "3.0.1", "info": { "title": "Dividend & ETF Scraper", "description": "Dividend history, growth metrics and ETF data by ticker: every payment (with record and pay dates), growth streak, 1-10 year dividend growth and TTM yield, plus a screener for stocks with 10, 25 or 50+ years of dividend increases. No login or API key.", "version": "0.3", "x-build-id": "eawOfZ47BeBH7qISd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sheshinmcfly~dividend-etf-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sheshinmcfly-dividend-etf-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/sheshinmcfly~dividend-etf-scraper/runs": { "post": { "operationId": "runs-sync-sheshinmcfly-dividend-etf-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/sheshinmcfly~dividend-etf-scraper/run-sync": { "post": { "operationId": "run-sync-sheshinmcfly-dividend-etf-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 fetch", "enum": [ "symbols", "screener" ], "type": "string", "description": "Symbols: full dividend history, growth metrics and ETF data for the tickers you list. Screener: find dividend stocks by years of consecutive increases, yield, market cap and sector.", "default": "symbols" }, "symbols": { "title": "Ticker symbols", "type": "array", "description": "Stock or ETF ticker symbols to fetch, e.g. AAPL, SPY, KO, VOO, SCHD. Used in Symbols mode.", "items": { "type": "string" } }, "dataTypes": { "title": "Data to extract", "type": "array", "description": "Which data blocks to include for each symbol.", "items": { "type": "string", "enum": [ "dividends", "etfProfile" ], "enumTitles": [ "Dividend history + growth metrics (every payment, annual totals, growth streak, 1/3/5/10-year growth, frequency, last raise or cut, TTM yield)", "ETF profile (expense ratio, yield, holdings, sector weights, asset mix, valuation, returns)" ] }, "default": [ "dividends" ] }, "includePaymentDates": { "title": "Add declaration, record and payment dates", "type": "boolean", "description": "For Nasdaq-listed symbols, each dividend also gets its declaration, record and payment dates (other exchanges keep the ex-date and amount).", "default": true }, "screenPreset": { "title": "Screen", "enum": [ "kings", "years25", "years10", "highYield", "custom" ], "type": "string", "description": "Ready-made dividend screens. The fields below refine any of them.", "default": "years25" }, "screenMinYears": { "title": "Min consecutive years of dividend increases", "minimum": 0, "type": "integer", "description": "Overrides the screen's own threshold." }, "screenMinYield": { "title": "Min forward dividend yield (%)", "minimum": 0, "type": "number", "description": "e.g. 3 = yield of 3% or more." }, "screenMinMarketCapB": { "title": "Min market cap (USD billions)", "minimum": 0, "type": "number", "description": "e.g. 10 = large caps only." }, "screenSector": { "title": "Sector", "enum": [ "", "Technology", "Healthcare", "Financial Services", "Consumer Cyclical", "Industrials", "Communication Services", "Consumer Defensive", "Energy", "Basic Materials", "Real Estate", "Utilities" ], "type": "string", "description": "Keep only one sector.", "default": "" }, "screenRegion": { "title": "Region", "enum": [ "us", "ca", "gb", "de", "fr", "ch", "jp", "au", "hk", "in", "br" ], "type": "string", "description": "Market to screen.", "default": "us" }, "screenSortBy": { "title": "Sort by", "enum": [ "years", "yield", "marketCap" ], "type": "string", "description": "Order of the results.", "default": "years" }, "screenVerifyWithHistory": { "title": "Check each stock's payment history (25+ and 50+ year screens)", "type": "boolean", "description": "Yahoo's count of years of increases misses some long-time raisers whose payment dates shifted (Coca-Cola shows 23). When on, 25+ and 50+ year screens also check each candidate's full payment history, so those companies are included. Takes about 30-40 seconds instead of a few.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum stocks to return in Screener mode.", "default": 100 }, "includeDividendDetails": { "title": "Add full dividend history to each result", "type": "boolean", "description": "Also fetch every screened stock's payment history and growth metrics (same data as Symbols mode). Slower: about 1 second per 6 stocks.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify datacenter proxies work for Yahoo Finance. Switch to Residential only if you hit rate limits.", "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 } } } } } } } } } }