{ "openapi": "3.0.1", "info": { "title": "TradingView Screener Scraper", "description": "Read instrument data from TradingView’s public scanner and save one row per exchange-qualified symbol. Results can include close, change, volume, market cap, sector, RSI, exchange, and type. Configure scanner columns, filters, market, sort order, and maximum results without a login.", "version": "1.0", "x-build-id": "BKiE9jNGIb62B0xY7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~tradingview-screener-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-tradingview-screener-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/axiomworks~tradingview-screener-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-tradingview-screener-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/axiomworks~tradingview-screener-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-tradingview-screener-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": { "market": { "title": "Market name (e.g. america)", "enum": [ "america", "crypto", "forex", "futures", "global", "uk", "germany", "india", "japan", "hongkong", "australia", "canada", "coin", "cfd", "bonds", "korea", "brazil", "france", "italy", "spain", "switzerland", "sweden", "netherlands", "turkey", "israel", "singapore" ], "type": "string", "description": "Scanner market to query, e.g. 'america' for US stocks, 'crypto', 'forex' or 'germany'. Default america screens all US instruments unless filters or symbols narrow it. Select the market containing your symbols; unsupported markets return zero rows with guidance.", "default": "america" }, "filters": { "title": "Filter objects (left, operation, right)", "type": "array", "description": "Conditions combined with AND, e.g. [{\"left\":\"type\",\"operation\":\"equal\",\"right\":\"stock\"}]. left is a scanner column; right is a number, text or array. Operations include greater, equal, in_range and match; >, = and between also work. Default [] adds no conditions. Filters also apply to symbols. Unknown columns or rejected filters are skipped with a warning; inspect logs before relying on a screen.", "items": { "type": "object", "properties": { "left": { "title": "Column", "description": "Scanner column to compare, e.g. \"market_cap_basic\", \"type\" or \"sector\".", "type": "string" }, "operation": { "title": "Operation", "description": "Comparison name, e.g. \"greater\", \"equal\" or \"in_range\"; aliases such as \">\" and \"between\" are accepted.", "type": "string" } } }, "default": [] }, "columns": { "title": "Extra column names (e.g. Recommend.All)", "type": "array", "description": "Extra scanner columns to return besides the standard ones, e.g. 'Recommend.All', 'price_earnings_ttm', 'dividends_yield_current'. Unknown columns are skipped with a warning. Default: name, description, close, change, volume, market_cap_basic, sector, RSI, exchange, type.", "items": { "type": "string" }, "default": [ "name", "description", "close", "change", "volume", "market_cap_basic", "sector", "RSI", "exchange", "type" ] }, "columnGroups": { "title": "Column sets (e.g. technicals)", "type": "array", "description": "Column sets to add, e.g. [\"technicals\",\"fundamentals\"]. Accepts technicals, fundamentals and performance; default []. Unavailable columns are skipped with a warning. Technicals adds indicators; fundamentals adds financial ratios; performance adds returns and ranges.", "items": { "type": "string", "enum": [ "technicals", "fundamentals", "performance" ] }, "default": [] }, "symbols": { "title": "Tickers (e.g. NASDAQ:AAPL)", "type": "array", "description": "Ticker strings in the selected market, e.g. [\"AAPL\",\"NASDAQ:NVDA\"]. Exchange-qualified tickers match exactly; bare tickers can match multiple exchanges. Filters still apply, so a listed ticker may return no row. Default [] screens the whole market. maxItems is shared across all tickers, not per ticker; no matches succeed with zero rows and guidance.", "items": { "type": "string" }, "default": [] }, "sortBy": { "title": "Sort column name (e.g. volume)", "type": "string", "description": "Scanner column to sort by, e.g. 'market_cap_basic', 'volume', 'change' or 'RSI'. Default market_cap_basic; ignored with a warning if the market lacks it.", "default": "market_cap_basic" }, "sortOrder": { "title": "Sort direction (e.g. desc)", "enum": [ "asc", "desc" ], "type": "string", "description": "Order matching rows by sortBy: 'desc' (largest first, default) or 'asc' (smallest first), e.g. 'asc' with sortBy 'close'. Applies to the selected market and filters before maxItems limits the returned rows.", "default": "desc" }, "maxItems": { "title": "Result limit (1–10000, e.g. 20)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Total unique instrument limit across the selected market and all symbols, e.g. 20. Integer 1-10000, default 50; not a per-symbol limit. Returns fewer if fewer rows match or the run's spending limit stops collection.", "default": 50 }, "proxyConfiguration": { "title": "Proxy options (e.g. useApifyProxy: false)", "type": "object", "description": "Apify Proxy options, e.g. {\"useApifyProxy\":false} (default) or {\"useApifyProxy\":true}. Blocked requests retry with backoff and use a fresh Apify Proxy session when available. Local runs may have no proxy access.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }