{ "openapi": "3.0.1", "info": { "title": "Yahoo Finance Summary + Key Statistics", "description": "Scrape Yahoo Finance summary and key statistics for multiple tickers with explicit per-row status, contract versioning, and optional parsed numeric fields.", "version": "1.0", "x-build-id": "BM3TDJJh6NY9HiHXL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/samfold~yahoo-finance-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-samfold-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/samfold~yahoo-finance-scraper/runs": { "post": { "operationId": "runs-sync-samfold-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/samfold~yahoo-finance-scraper/run-sync": { "post": { "operationId": "run-sync-samfold-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", "properties": { "tickers": { "title": "Stock Tickers", "minItems": 1, "maxItems": 500, "type": "array", "description": "Ticker symbols to scrape. Duplicates are removed automatically.", "items": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9.-]{0,9}$" } }, "crawlMode": { "title": "Crawl Mode", "enum": [ "full", "summary", "statistics" ], "type": "string", "description": "Select whether to require summary, statistics, or both module families.", "default": "full" }, "includeParsedFields": { "title": "Include Parsed Numeric Fields", "type": "boolean", "description": "Adds typed numeric helper fields such as currentPriceNum and marketCapIntradayNum.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 64, "type": "integer", "description": "Maximum number of tickers processed in parallel.", "default": 16 }, "maxRetries": { "title": "Max Retries", "minimum": 0, "maximum": 8, "type": "integer", "description": "Retries for retryable failures (transport errors, 429, selected transient failures).", "default": 2 }, "retryBackoffMs": { "title": "Retry Backoff (ms)", "minimum": 50, "maximum": 30000, "type": "integer", "description": "Base backoff in milliseconds; retries use linear backoff (base * attempt).", "default": 400 }, "timeoutSecs": { "title": "Request Timeout (secs)", "minimum": 3, "maximum": 120, "type": "integer", "description": "Per-request timeout in seconds.", "default": 12 }, "host": { "title": "Yahoo Host", "type": "string", "description": "Yahoo Finance host, for example finance.yahoo.com or uk.finance.yahoo.com.", "default": "finance.yahoo.com" }, "lang": { "title": "Accept-Language", "type": "string", "description": "Accept-Language header used for requests.", "default": "en-US" }, "region": { "title": "Region Label", "type": "string", "description": "Metadata region label for output rows.", "default": "US" }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Use Apify Proxy credentials from actor environment variables. Recommended for reliability.", "default": true }, "apifyProxyGroups": { "title": "Apify Proxy Groups", "type": "array", "description": "Optional Apify Proxy group names (for example RESIDENTIAL).", "items": { "type": "string" } }, "apifyProxyCountry": { "title": "Apify Proxy Country", "type": "string", "description": "Optional country code for Apify Proxy (for example US, GB)." }, "proxyUrls": { "title": "Custom Proxy URLs", "type": "array", "description": "Optional explicit proxy URLs. If provided, these override useApifyProxy.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }