{ "openapi": "3.0.1", "info": { "title": "Hong Kong Listed Companies Dataset (Wikidata, CC0)", "description": "Hong Kong Stock Exchange listed companies from Wikidata (CC0): code, English/Chinese names, listing date, founding date, industry, website, with per-field provenance and licence attribution. Filter by listing date, industry or GEM.", "version": "1.0", "x-build-id": "gqQ2MoRmyNIgP0D8H" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tiezhengzhang~hk-listed-companies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tiezhengzhang-hk-listed-companies", "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/tiezhengzhang~hk-listed-companies/runs": { "post": { "operationId": "runs-sync-tiezhengzhang-hk-listed-companies", "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/tiezhengzhang~hk-listed-companies/run-sync": { "post": { "operationId": "run-sync-tiezhengzhang-hk-listed-companies", "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": { "mode": { "title": "Mode", "enum": [ "list", "codes", "search" ], "type": "string", "description": "What to return.", "default": "list" }, "since": { "title": "Listed on or after", "type": "string", "description": "YYYY, YYYY-MM or YYYY-MM-DD (list mode)." }, "until": { "title": "Listed on or before", "type": "string", "description": "YYYY, YYYY-MM or YYYY-MM-DD, inclusive (list mode)." }, "industry": { "title": "Industry contains", "type": "string", "description": "Substring of the Wikidata industry label, English or Chinese, e.g. 'bank', 'retail', '零售' (list mode)." }, "board": { "title": "Board", "enum": [ "all", "gem" ], "type": "string", "description": "Restrict to GEM codes (08001-08999) or return all boards.", "default": "all" }, "hasFields": { "title": "Only records that have", "type": "array", "description": "Keep only records where all these fields are present (list mode).", "items": { "type": "string", "enum": [ "nameEn", "nameZh", "listingDate", "inception", "industry", "website", "offerPrice", "lotSize" ] } }, "onlyWithListingDate": { "title": "Only records with a listing date", "type": "boolean", "description": "List mode: skip companies whose Wikidata entry has no HKEX listing start date.", "default": true }, "sort": { "title": "Sort", "enum": [ "newest", "oldest" ], "type": "string", "description": "Order by listing date.", "default": "newest" }, "stockCodes": { "title": "Stock codes", "type": "array", "description": "Codes mode, e.g. 700, 0700, 00700 or 0700.HK.", "items": { "type": "string" } }, "query": { "title": "Search query", "type": "string", "description": "Search mode: English or Chinese name fragment, or a stock code." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper bound on results (and therefore cost).", "default": 1000 }, "includeProvenance": { "title": "Include provenance & attribution", "type": "boolean", "description": "Adds source URL, licence, retrieval date and note for every field, plus an attribution block.", "default": true }, "dataSource": { "title": "Data source", "enum": [ "auto", "live", "snapshot" ], "type": "string", "description": "Live runs one SPARQL query against Wikidata (a few seconds).", "default": "auto" } } }, "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 } } } } } } } } } }