{ "openapi": "3.0.1", "info": { "title": "Taiwan Short Sale Volume — 融券借券賣出成交量值 API", "description": "How much of every Taiwan listed and OTC stock was actually sold short each day: margin short sale (融券) and securities borrowing (借券賣出) lots and turnover, from TWSE and TPEx, back to 2008. Flow, not balance — and every row's implied price is checked against the day's own high and low.", "version": "0.1", "x-build-id": "iPCPZhdD74JEzuZaT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chamarix~taiwan-short-sale-volume/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chamarix-taiwan-short-sale-volume", "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-short-sale-volume/runs": { "post": { "operationId": "runs-sync-chamarix-taiwan-short-sale-volume", "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-short-sale-volume/run-sync": { "post": { "operationId": "run-sync-chamarix-taiwan-short-sale-volume", "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": { "startDate": { "title": "Start date (YYYY-MM-DD)", "pattern": "^(|\\d{4}[-/]\\d{2}[-/]\\d{2})$", "type": "string", "description": "First session to fetch. Leave both dates empty for the most recent session with data, which is what a Monday-morning or holiday run wants. TWSE's archive opens 2008-09-26 and TPEx's 2008-10-01; an earlier date simply starts there.", "default": "" }, "endDate": { "title": "End date (YYYY-MM-DD)", "pattern": "^(|\\d{4}[-/]\\d{2}[-/]\\d{2})$", "type": "string", "description": "Last session to fetch, inclusive. Defaults to today when only a start date is given. Weekends are skipped without a request; weekday holidays cost one request and come back empty.", "default": "" }, "market": { "title": "Market", "enum": [ "both", "twse", "tpex" ], "type": "string", "description": "Both exchanges, or one of them. TPEx did not publish this report between 2009-07-31 and 2012-05-29; those days are skipped with a warning rather than requested, and TWSE covers the period without interruption.", "default": "both" }, "stockCodes": { "title": "Stock codes", "type": "array", "description": "Keep only these securities, e.g. 2330, 6488. Leave empty for the whole market — roughly 2,350 securities a day across both exchanges. Filtering happens after the fetch, so it cuts the output rather than the request count.", "default": [], "items": { "type": "string" } }, "minTotalShortValue": { "title": "Minimum total short sale turnover (NT$)", "minimum": 0, "type": "integer", "description": "Drop rows whose margin plus borrowed short sale turnover falls below this. Most securities print zeros on any given day; set 1 to keep only those actually sold short, or e.g. 10000000 for the NT$10m-and-up names.", "default": 0 }, "verifyAgainstQuotes": { "title": "Cross-check the implied price against the day's range", "type": "boolean", "description": "Fetches each day's closing-price report as well and checks that turnover divided by shares lands inside that security's own high and low — an independent confirmation that the lot and dollar columns are the pair they are taken for. Also fills in day_high, day_low and day_close. Costs one extra request per market-day; turn it off for a long backfill.", "default": true }, "maxDays": { "title": "Maximum sessions", "minimum": 0, "type": "integer", "description": "A safety cap on how many weekdays one run will fetch, so an accidental 'since 2008' does not become a surprise bill. When a range exceeds it the most recent days are kept. Set 0 to lift it. Ignored when both dates are empty.", "default": 30 } } }, "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 } } } } } } } } } }