{
"openapi": "3.0.1",
"info": {
"title": "Finviz Scraper - Stock Screener, Fundamentals & Insider Trading",
"description": "Scrape Finviz: stock screener with 70+ fundamental & technical fields, full per-ticker fundamentals, analyst ratings, insider trading, news & sector/industry performance. Filter by any criteria or signal, monitor new insider buys & screener matches.",
"version": "0.1",
"x-build-id": "VnP6kagA5Mg6kvQNj"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapesage~finviz-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapesage-finviz-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/scrapesage~finviz-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapesage-finviz-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/scrapesage~finviz-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapesage-finviz-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 scrape",
"enum": [
"screener",
"ticker",
"insider",
"news",
"groups"
],
"type": "string",
"description": "Screener = filter the whole US market (70+ fields per stock). Ticker fundamentals = full report per symbol (fundamentals + analyst ratings + insider trades + news). Insider trading = the market-wide insider transaction feed. News = the market news & blogs feed. Group performance = sector / industry / country / cap performance.",
"default": "screener"
},
"screenerUrl": {
"title": "Screener URL (paste from Finviz)",
"type": "string",
"description": "Build a screen on finviz.com/screener.ashx, copy the URL and paste it here — every filter & signal is honored. Overrides the filter fields below. Example: https://finviz.com/screener.ashx?v=111&f=cap_largeover,sec_technology,fa_pe_u30"
},
"filters": {
"title": "Filter codes",
"type": "array",
"description": "Raw Finviz filter codes, combined with AND. Examples: cap_largeover (large cap+), sec_technology (sector), fa_pe_u30 (P/E < 30), fa_div_o3 (dividend > 3%), sh_avgvol_o500 (avg volume > 500K), geo_usa. See the Finviz screener filter bar for all codes.",
"items": {
"type": "string"
}
},
"signal": {
"title": "Signal preset",
"enum": [
"",
"topGainers",
"topLosers",
"newHigh",
"newLow",
"mostVolatile",
"mostActive",
"unusualVolume",
"overbought",
"oversold",
"upgrades",
"downgrades",
"earningsBefore",
"earningsAfter",
"recentInsiderBuying",
"recentInsiderSelling",
"majorNews",
"channelUp",
"channelDown",
"doubleTop",
"doubleBottom",
"wedgeUp",
"wedgeDown"
],
"type": "string",
"description": "A Finviz signal list — the 'what's moving' screens traders watch. Leave as None to use filters only.",
"default": ""
},
"order": {
"title": "Sort order",
"type": "string",
"description": "Finviz sort code, e.g. -marketcap (largest first), -change (top % change), -volume, pe (lowest P/E first), -dividendyield. Prefix with - for descending."
},
"tickersFilter": {
"title": "Limit screener to tickers",
"type": "string",
"description": "Optional comma-separated ticker list to restrict the screen to, e.g. AAPL,MSFT,NVDA."
},
"includeTickerDetails": {
"title": "Enrich each stock with full fundamentals",
"type": "boolean",
"description": "Open each screened stock's quote page to add the full fundamentals snapshot, analyst ratings, insider trades & news (one extra request per stock — slower, charged as a ticker report).",
"default": false
},
"tickers": {
"title": "Tickers",
"type": "array",
"description": "Stock symbols to pull full fundamentals for, e.g. AAPL, MSFT, TSLA. Used when mode = Ticker fundamentals.",
"items": {
"type": "string"
}
},
"insiderTab": {
"title": "Insider feed",
"enum": [
"latest",
"latestBuys",
"latestSales",
"topWeek",
"topOwnerWeek"
],
"type": "string",
"description": "Which insider-trading feed to pull. Used when mode = Insider trading.",
"default": "latest"
},
"includeBlogs": {
"title": "Include blogs in news",
"type": "boolean",
"description": "Include financial blog posts alongside news articles. Used when mode = News.",
"default": true
},
"groupType": {
"title": "Group by",
"enum": [
"sector",
"industry",
"country",
"capitalization"
],
"type": "string",
"description": "Which market grouping to report performance for. Used when mode = Group performance.",
"default": "sector"
},
"groupView": {
"title": "Group view",
"enum": [
"performance",
"valuation",
"overview"
],
"type": "string",
"description": "Performance (price changes), Valuation (P/E, P/S…) or Overview.",
"default": "performance"
},
"startUrls": {
"title": "Start URLs (any Finviz page)",
"type": "array",
"description": "Paste any Finviz URLs — screener, quote (quote.ashx?t=AAPL), insider, news or groups pages. Each is auto-routed to the right scraper. Used in addition to the mode above.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"maxResults": {
"title": "Max results",
"minimum": 0,
"type": "integer",
"description": "Maximum number of records to return for this run (0 = no limit). For the screener, results are fetched 20 per page.",
"default": 100
},
"monitorMode": {
"title": "Monitor mode (only new data)",
"type": "boolean",
"description": "Remember records seen on previous runs (in a named key-value store) and output only NEW ones — perfect for alerting on new insider buys, fresh screener matches or new articles. Combine with Apify Schedules to poll automatically.",
"default": false
},
"monitorStoreName": {
"title": "Monitor store name",
"type": "string",
"description": "Name of the key-value store that holds the 'seen' fingerprints for monitor mode. Use different names to track different watchlists/screens independently.",
"default": "finviz-monitor"
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Finviz works on Apify's datacenter proxy. Datacenter is recommended (fast & cheap).",
"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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}