{ "openapi": "3.0.1", "info": { "title": "TAIFEX Institutional Traders — Taiwan Futures & Options", "description": "Daily dealer, investment trust and foreign institutional positions across all 23 TAIFEX futures and 5 options contracts: long/short volume, net flow and open interest, plus the TAIEX options put/call ratio. Official Taiwan Futures Exchange data for positioning analysis and quant research.", "version": "0.1", "x-build-id": "TvhtyvOFg4SNAdSU9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chamarix~taifex-institutional-derivatives/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chamarix-taifex-institutional-derivatives", "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~taifex-institutional-derivatives/runs": { "post": { "operationId": "runs-sync-chamarix-taifex-institutional-derivatives", "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~taifex-institutional-derivatives/run-sync": { "post": { "operationId": "run-sync-chamarix-taifex-institutional-derivatives", "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. TAIFEX serves this report for roughly the last 3 years only; earlier dates come back empty.", "default": "2026-07-30" }, "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": "" }, "dataType": { "title": "Data type", "enum": [ "both", "futures", "options" ], "type": "string", "description": "Which report to fetch: futures (23 contracts x 3 institutions = 69 rows/day), options (5 contracts x call/put x 3 institutions = 30 rows/day), or both.", "default": "both" }, "contracts": { "title": "Contract filter", "type": "array", "description": "Optional list of contract codes to keep, e.g. ['TXF', 'MXF', 'TXO']. Chinese product names such as '臺股期貨' also work. Leave empty for all contracts. Futures: TXF EXF FXF MXF TMF ZEF ZFF STF ETF GTF XIF G2F M1F E4F BTF SOF SHF TJF SPF UNF UDF SXF F1F. Options: TXO TEO TFO STO ETC.", "default": [], "items": { "type": "string" } }, "institutions": { "title": "Institution filter", "type": "array", "description": "Optional list of institution types to keep. Leave empty for all three.", "items": { "type": "string", "enum": [ "DEALER", "INVESTMENT_TRUST", "FOREIGN" ], "enumTitles": [ "Dealers (自營商)", "Investment trusts (投信)", "Foreign & mainland investors (外資及陸資)" ] }, "default": [] }, "includePutCallRatio": { "title": "Include TAIEX options put/call ratio", "type": "boolean", "description": "Also output one put/call ratio row per trading day (volume and open-interest ratios for TXO). Adds a handful of rows to the dataset.", "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 } } } } } } } } } }