{ "openapi": "3.0.1", "info": { "title": "Finviz Stocks Scraper (Fundamentals, Screener, Insider)", "description": "Scrape Finviz stock quotes with the full ~70-metric fundamentals snapshot, run the screener with filters, and pull insider trades and news. Get Market Cap, P/E, EPS, margins, ROE, short float and more. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "RWkBNoDGkhFiJcU24" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~finviz-stocks-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-finviz-stocks-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~finviz-stocks-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-finviz-stocks-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~finviz-stocks-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-finviz-stocks-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": "Mode", "enum": [ "quote", "screener" ], "type": "string", "description": "quote = pull the full fundamentals snapshot for each ticker. screener = list stocks matching filters.", "default": "quote" }, "tickers": { "title": "Tickers", "type": "array", "description": "Stock tickers to pull fundamentals for in quote mode, e.g. AAPL, MSFT, NVDA. One record per ticker with the full snapshot.", "items": { "type": "string" } }, "screenerFilters": { "title": "Raw screener filters", "type": "string", "description": "Screener mode only. Raw Finviz f= value, e.g. cap_large,sec_technology,fa_pe_u20. Combined with the friendly filters below. Leave empty to use only the friendly filters." }, "marketCap": { "title": "Market cap (screener)", "enum": [ "", "mega", "large", "mid", "small", "micro", "nano", "large+", "small-" ], "type": "string", "description": "Screener mode friendly filter for market capitalization.", "default": "" }, "sector": { "title": "Sector (screener)", "enum": [ "", "Basic Materials", "Communication Services", "Consumer Cyclical", "Consumer Defensive", "Energy", "Financial", "Healthcare", "Industrials", "Real Estate", "Technology", "Utilities" ], "type": "string", "description": "Screener mode friendly filter for sector.", "default": "" }, "exchange": { "title": "Exchange (screener)", "enum": [ "", "NASDAQ", "NYSE", "AMEX" ], "type": "string", "description": "Screener mode friendly filter for listing exchange.", "default": "" }, "index": { "title": "Index (screener)", "enum": [ "", "SP500", "DJIA", "NASDAQ100" ], "type": "string", "description": "Screener mode friendly filter to restrict to a major index.", "default": "" }, "maxResults": { "title": "Max Stocks To Scrape", "minimum": 1, "type": "integer", "description": "Maximum number of stock records to collect across the whole run. Free Apify plans are capped at 10 per run." }, "includeInsiderNews": { "title": "Add insider trades and news (paid add-on, off by default)", "type": "boolean", "description": "Quote mode only. Attach the insider-trading table (buys/sells with insider, relationship, shares, value) and the latest news headlines for each ticker. Charged only when real insider rows or news are returned. Disabled on free plans.", "default": false }, "aiStockSummary": { "title": "Add AI stock summary (paid add-on, off by default)", "type": "boolean", "description": "Quote mode only. Use AI to add a valuation read, financial-health note, notable signals and a one-line summary from the fundamentals. Charged only when a usable summary is returned. Disabled on free plans.", "default": false } } }, "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 } } } } } } } } } }