{ "openapi": "3.0.1", "info": { "title": "πŸ‡ΉπŸ‡Ό Taiwan TWSE Screener Β· 台灣證亀所選肑", "description": "TWSE + TPEx Taiwan stock screener API β€” live quotes, market cap (TWD), P/E, P/B, dividend yield, ROE, sector. TSMC, MediaTek, Hon Hai universe. Bloomberg Terminal / FactSet / Refinitiv Eikon alternative. For hedge funds, quant analysts, semiconductor researchers. Pay-per-result.", "version": "0.0", "x-build-id": "PoseRp8788aMXj5iP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~twse-stock-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-twse-stock-screener", "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/nexgendata~twse-stock-screener/runs": { "post": { "operationId": "runs-sync-nexgendata-twse-stock-screener", "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/nexgendata~twse-stock-screener/run-sync": { "post": { "operationId": "run-sync-nexgendata-twse-stock-screener", "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": { "limit": { "title": "Limit", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of TWSE-listed stocks to return. The Taiwan Stock Exchange has roughly 1,000 listed companies plus ~350 ETFs/warrants. Use 10 for a smoke test, 200 for the large-cap universe, or 2000 to pull everything. Records are returned sorted by trading value (a liquidity-weighted proxy for market cap) descending.", "default": 200 }, "min_trade_value_twd": { "title": "Min daily trade value (TWD)", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "Filter to stocks with daily trade value (price Γ— volume in TWD) above this threshold. Useful for excluding illiquid names. Examples: 100000000 = 1ε„„ TWD/day (mid-large cap), 1000000000 = 10ε„„ TWD/day (TSMC tier). Leave at 0 for no filter.", "default": 0 }, "min_volume": { "title": "Min daily volume (shares)", "minimum": 0, "maximum": 10000000000, "type": "integer", "description": "Filter to stocks with daily share volume above this threshold. Useful for excluding stocks that didn't trade. Examples: 1000 = at least 1 board lot of activity, 1000000 = 1M shares (active names). Leave at 0 for no filter.", "default": 0 }, "max_pe_ratio": { "title": "Max P/E ratio", "minimum": 0, "maximum": 1000, "type": "number", "description": "Filter to stocks with P/E ratio at or below this value (value-investor screen). Examples: 15 = classic Graham value, 25 = GARP. Stocks with no reported P/E (e.g. loss-making) are excluded when this filter is set. Leave at 0 to disable.", "default": 0 }, "min_dividend_yield": { "title": "Min dividend yield (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Filter to stocks with trailing dividend yield at or above this value (in percent). Taiwan is famous for its high-dividend equity culture β€” many large-caps yield 4-7%. Examples: 4 = solid income, 6 = top-decile high-yielder. Leave at 0 for no filter.", "default": 0 }, "sector": { "title": "Sector / industry / name keyword", "type": "string", "description": "Optional case-insensitive substring filter applied to the TWSE industry classification name and the company name. Examples: 'εŠε°Žι«”' (semiconductor), 'electronic', 'ι‡‘θž' (finance), 'η”ŸζŠ€' (biotech), 'TSMC'. Leave blank for no filter. Industry data is fetched automatically from the TWSE company-info endpoint." }, "include_etfs": { "title": "Include ETFs and warrants", "type": "boolean", "description": "If true, return ETF tickers (4-digit codes starting with 00, e.g. 0050 元倧台灣50, 0056 ε…ƒε€§ι«˜θ‚‘ζ―) and warrants alongside common stocks. If false, only return ordinary common-stock listings (4-digit codes 1xxx-9xxx). Default false to keep the universe focused on operating companies.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. The TWSE OpenAPI endpoints are public and global, so the datacenter proxy default works fine. Switch to RESIDENTIAL only if you hit rate limits.", "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 } } } } } } } } } }