{ "openapi": "3.0.1", "info": { "title": "🇭🇰 HK Companies Registry · 公司註冊處 CR 編號 董事查冊", "description": "Search HK Companies Registry (ICRIS) by name / CR number / entity type / status. Returns CR number, entity type, status, address, directors, secretary, share capital HKD, business nature. KYC, AML, M&A — Bloomberg/Refinitiv/BVD alt.", "version": "0.0", "x-build-id": "uSNzcB8HFfQza0bQP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~hk-companies-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-hk-companies-registry", "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~hk-companies-registry/runs": { "post": { "operationId": "runs-sync-nexgendata-hk-companies-registry", "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~hk-companies-registry/run-sync": { "post": { "operationId": "run-sync-nexgendata-hk-companies-registry", "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": { "search_query": { "title": "Company name / keyword (English or Chinese, partial match)", "type": "string", "description": "Partial-match company-name search. Searches Hong Kong's Companies Registry (ICRIS) plus aggregated public lists (HKEX-listed and HK's largest private companies). Matches against both English and Chinese (Traditional) names. Leave empty to retrieve the full curated universe filtered by the other fields. Example: 'HSBC', 'CK Hutchison', 'Tencent', '腾讯'." }, "cr_number": { "title": "CR number — Companies Registry number (exact match)", "type": "string", "description": "Hong Kong's Companies Registry number — the canonical 7-digit registry-issued identifier for every Hong Kong-incorporated entity (e.g. '0263875' for HSBC Holdings plc, '0001'-prefix for the oldest entities). Exact match. Takes precedence over search_query when both are provided." }, "entity_type": { "title": "Entity type", "enum": [ "ALL", "PRIVATE", "PUBLIC", "FOREIGN", "GUARANTEE", "UNLIMITED" ], "type": "string", "description": "Filter by Companies Registry entity type. 'ALL' returns everything. 'PRIVATE' covers private companies limited by shares — the dominant form in HK. 'PUBLIC' covers HKEX-listed and other public limited companies. 'FOREIGN' covers non-Hong Kong companies registered under Part 16 of the Companies Ordinance. 'GUARANTEE' covers companies limited by guarantee (charities, NGOs).", "default": "ALL" }, "status": { "title": "Entity status", "enum": [ "ALL", "LIVE", "DISSOLVED", "WINDING_UP", "STRUCK_OFF", "DORMANT" ], "type": "string", "description": "Filter by registry status. 'LIVE' = currently active and in good standing. 'DISSOLVED' = formally wound up and removed from the register. 'WINDING_UP' = currently in liquidation. 'STRUCK_OFF' = removed from the register for non-compliance (typically failure to file annual returns). 'ALL' returns every status.", "default": "LIVE" }, "incorporation_date_from": { "title": "Incorporated on or after (YYYY-MM-DD)", "type": "string", "description": "Lower bound on incorporation date in ISO format (YYYY-MM-DD). Use this together with `incorporation_date_to` to find newly-formed entities (VC sourcing) or vintage entities (legacy due diligence). Leave empty for no lower bound." }, "incorporation_date_to": { "title": "Incorporated on or before (YYYY-MM-DD)", "type": "string", "description": "Upper bound on incorporation date in ISO format (YYYY-MM-DD). Pair with `incorporation_date_from` to bound the formation window. Leave empty for no upper bound." }, "limit": { "title": "Max companies returned", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on total companies returned in this run (1-2000). Each company is one dataset row. Premium pricing applies per row ($0.10/company).", "default": 50 } } }, "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 } } } } } } } } } }