{ "openapi": "3.0.1", "info": { "title": "Hong Kong SFC Licensed Persons & Institutions Register Scraper", "description": "Search the Hong Kong SFC Public Register: CE number, regulated activities (Type 1-13 + virtual asset), licence status, address, responsible officers, accredited firms, conditions and disciplinary actions. For KYC, KYB and AML. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "FRWZY9u9IERd14h4S" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~hongkong-sfc-licensees-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-hongkong-sfc-licensees-scraper", "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/scrapers_lat~hongkong-sfc-licensees-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-hongkong-sfc-licensees-scraper", "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/scrapers_lat~hongkong-sfc-licensees-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-hongkong-sfc-licensees-scraper", "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": { "searchQueries": { "title": "Names Or Keywords", "type": "array", "description": "Firm, corporation or person names, or sector keywords to search on the SFC register. One run searches every entry.", "items": { "type": "string" } }, "entityType": { "title": "Search On", "enum": [ "corporation", "individual" ], "type": "string", "description": "Whether the name / activity search targets corporations (licensed corporations & registered institutions) or individuals (representatives & responsible officers).", "default": "corporation" }, "ceNumbers": { "title": "CE Numbers", "type": "array", "description": "Specific Central Entity (CE) numbers to look up directly, e.g. AAA347 (faster and exact).", "items": { "type": "string" } }, "regulatedActivityType": { "title": "List All By Regulated Activity Type", "enum": [ "", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "13", "101" ], "type": "string", "description": "Optional: enumerate EVERY licensee that holds a given regulated-activity type (great for lead lists, e.g. all asset managers). Leave blank to use name / CE search instead.", "default": "" }, "licenceStatus": { "title": "Licence Status", "enum": [ "active", "all" ], "type": "string", "description": "Return only currently active licensees, or include inactive / ceased ones too.", "default": "active" }, "licenceType": { "title": "Licence Type", "enum": [ "all", "sfo", "amlo" ], "type": "string", "description": "Filter by licence regime: SFO licence, AMLO licence (virtual asset), or both.", "default": "all" }, "searchLanguage": { "title": "Name Language", "enum": [ "en", "tc" ], "type": "string", "description": "Whether the search text is an English or Traditional Chinese name.", "default": "en" }, "filterActivityTypes": { "title": "Filter By Regulated Activity Types", "type": "array", "description": "Optional: keep only results that hold at least one of these regulated-activity type numbers (e.g. [\"1\", \"9\"]). Applied to name / CE searches.", "items": { "type": "string" } }, "includeDetails": { "title": "Include Full Details", "type": "boolean", "description": "Fetch each licensee's detail page: responsible officers / accredited firms with dates, licensing conditions, previous names and public disciplinary actions. Turn off for faster, list-only results.", "default": true }, "maxLicensees": { "title": "Max Licensees To Scrape", "minimum": 1, "type": "integer", "description": "Maximum number of licensees to return across all searches.", "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 } } }, "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 } } } } } } } } } }