{ "openapi": "3.0.1", "info": { "title": "Stock Corporate Events Calendar Scraper", "description": "Scrape upcoming earnings, dividends, IPOs and stock splits in one unified calendar. Filter by date range, symbol and event type. Optional live price snapshot and AI event preview. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "7wMqMbY3TjiFCmMFZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~stock-corporate-events-calendar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-stock-corporate-events-calendar-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/scrapers_lat~stock-corporate-events-calendar-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-stock-corporate-events-calendar-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/scrapers_lat~stock-corporate-events-calendar-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-stock-corporate-events-calendar-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": { "eventTypes": { "title": "Event types", "type": "array", "description": "Which corporate events to collect. Any subset of earnings, dividends, ipos, splits. One unified record per event across all selected types.", "items": { "type": "string", "enum": [ "earnings", "dividends", "ipos", "splits" ], "enumTitles": [ "Upcoming earnings", "Dividends (ex-date)", "IPOs", "Stock splits" ] }, "default": [ "earnings" ] }, "dateFrom": { "title": "Date from", "type": "string", "description": "Start date (YYYY-MM-DD). Defaults to the day the run starts. For earnings, dividends and splits the actor loops each day in the range (capped at 31 days); for IPOs it covers each month spanned." }, "dateTo": { "title": "Date to", "type": "string", "description": "End date (YYYY-MM-DD), inclusive. Defaults to the same day as Date from. Keep the range under 31 days for the daily calendars." }, "symbols": { "title": "Symbols filter", "type": "array", "description": "Optional. Only keep events for these ticker symbols, e.g. AAPL, MSFT, NVDA. Case-insensitive, applied client-side. Leave empty to return every event on the calendar.", "items": { "type": "string" } }, "includePriceSnapshot": { "title": "Add live price snapshot (paid add-on, off by default)", "type": "boolean", "description": "For each event, make an extra fetch for the symbol's live quote and attach last price, net change, percent change, volume and 52-week range (and compute dividend yield for dividend rows). Charged only when a real quote is returned. Disabled on free plans.", "default": false }, "aiEventPreview": { "title": "Add AI event preview (paid add-on, off by default)", "type": "boolean", "description": "Use AI to add a plain-English context line, year-over-year EPS growth (earnings), a setup note, risk flags and a one-line summary per event. Charged only when a usable preview is returned. Disabled on free plans.", "default": false }, "maxResults": { "title": "Max Events To Scrape", "minimum": 1, "type": "integer", "description": "Maximum number of corporate-event records to collect across the whole run. Free Apify plans are capped at 10 per run." } } }, "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 } } } } } } } } } }