{ "openapi": "3.0.1", "info": { "title": "Taiwan Foreign & Mainland Shareholding (TWSE + TPEx)", "description": "Daily foreign and mainland-Chinese ownership for all 2,200+ Taiwan listed & OTC securities: issued shares, shares held, shares still available, statutory ownership caps and quota utilisation in one normalized JSON schema. Official TWSE/TPEx data back to 2004.", "version": "0.1", "x-build-id": "qZok2pv2LBwHNAoth" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chamarix~taiwan-foreign-shareholding/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chamarix-taiwan-foreign-shareholding", "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/chamarix~taiwan-foreign-shareholding/runs": { "post": { "operationId": "runs-sync-chamarix-taiwan-foreign-shareholding", "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/chamarix~taiwan-foreign-shareholding/run-sync": { "post": { "operationId": "run-sync-chamarix-taiwan-foreign-shareholding", "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", "required": [ "startDate" ], "properties": { "startDate": { "title": "Start date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Start date in YYYY-MM-DD format. TWSE history goes back to 2004-02-11, TPEx to 2007-05-02.", "default": "2026-08-07" }, "endDate": { "title": "End date", "pattern": "^(|\\d{4}-\\d{2}-\\d{2})$", "type": "string", "description": "End date in YYYY-MM-DD format (inclusive). Leave empty to scrape only the start date.", "default": "" }, "market": { "title": "Market", "enum": [ "both", "twse", "tpex" ], "type": "string", "description": "Which market to fetch: both (TWSE listed + TPEx OTC), twse only, or tpex only.", "default": "both" }, "stockCodes": { "title": "Stock codes filter", "type": "array", "description": "Optional list of stock codes to filter (e.g., ['2330', '5274']). Leave empty to get all securities.", "default": [], "items": { "type": "string" } }, "minForeignHoldingPct": { "title": "Minimum foreign holding (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only output securities whose foreign + mainland holding percentage is at least this value. Useful for isolating the heavily foreign-owned end of the market. 0 = no filter.", "default": 0 }, "capRestrictedOnly": { "title": "Only securities with a statutory ownership cap below 100%", "type": "boolean", "description": "Restrict output to securities whose legal foreign ownership ceiling is under 100% (telecoms, broadcasting, transport and other regulated sectors). These are the only stocks where a foreign ownership quota squeeze can actually happen — sort them by quota_utilization_pct to find the tightest.", "default": false }, "verifyWithIndustryTotals": { "title": "Cross-check against the TWSE industry aggregate table", "type": "boolean", "description": "When the run covers the latest TWSE session and no stock filter is set, fetch the independent MI_QFIIS_cat industry summary and assert that security count, issued shares and held shares reconcile exactly. Adds one request and logs the result.", "default": 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 } } } } } } } } } }