{ "openapi": "3.0.1", "info": { "title": "HKEX Disclosure & Announcements Scraper", "description": "Scrape Hong Kong Exchange (HKEXnews) listed-company announcements and disclosures. Search by stock code or company name, filter by headline category, document type, date range, and title keyword. Get stock code, company name, announcement title, category, publish date, and PDF document URL.", "version": "1.0", "x-build-id": "BRUabb1GhY2AKKUtf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~hkex-disclosure-announcements-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-hkex-disclosure-announcements-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/crawlerbros~hkex-disclosure-announcements-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-hkex-disclosure-announcements-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/crawlerbros~hkex-disclosure-announcements-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-hkex-disclosure-announcements-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": { "stockQuery": { "title": "Stock code or company name", "type": "string", "description": "Restrict results to one listed security. Enter an exact stock code (e.g. `00700`) or part of the company name (e.g. `Tencent`). Leave blank to search across all listed securities." }, "headlineCategory": { "title": "Headline category", "enum": [ "", "10000", "20000", "30000", "40000", "50000", "51500", "52000", "53000", "54000", "55000", "56000", "57000", "58000", "59000", "70000", "80000", "81000", "90000", "91000" ], "type": "string", "description": "Restrict results to one HKEX headline category. Leave as \"All categories\" to search every category.", "default": "" }, "documentSubCategory": { "title": "Sub-category (within headline category)", "enum": [ "", "13100", "15100", "12100", "17100", "17150", "18100", "11100", "18110", "19100", "18120", "18140", "12150", "15000", "18160", "12951", "12200", "12550", "12050", "12250", "12300", "12350", "12400", "17950", "12450", "12500", "12959", "17200", "12600", "18180", "12950", "12650", "12700", "18200", "12961", "12957", "14100", "17250", "19150", "19200", "18220", "17300", "11200", "18240", "11300", "18260", "13150", "17350", "16100", "19250", "13200", "16200", "13250", "13251", "13300", "13350", "15200", "17400", "17450", "11400", "19750", "18280", "13400", "18300", "18320", "18340", "18360", "18380", "18400", "18420", "17500", "12952", "15300", "17550", "19300", "16300", "14200", "19400", "19350", "19700", "15700", "13550", "18440", "13450", "14300", "12750", "12800", "12850", "12962", "12900", "12953", "14400", "14500", "18460", "19450", "19760", "19770", "19780", "19790", "19800", "19500", "19810", "19820", "19830", "19840", "19850", "19870", "19860", "18480", "19550", "13750", "17600", "13500", "13600", "14600", "14700", "14800", "14900", "13650", "17650", "16400", "13700", "13800", "18500", "18560", "18580", "18520", "16500", "17700", "15400", "17750", "17800", "15500", "17850", "16600", "12958", "12954", "12955", "12956", "18540", "17960", "15600", "19600", "19650", "16700", "16800", "16900", "11500", "17900", "91200", "91300", "91100", "22100", "26100", "23500", "26150", "23100", "21100", "21200", "24100", "25100", "25200", "26200", "26250", "26300", "25300", "26350", "26400", "26450", "26500", "26550", "26600", "26650", "26700", "24200", "23200", "27100", "23300", "26750", "27900", "25400", "25500", "23400", "24300", "26800", "26950", "26900", "26850", "25600", "24400", "24500", "72300", "72500", "72100", "72661", "72741", "72660", "72740", "72950", "72820", "73500", "73100", "73300", "76800", "75400", "72900", "72910", "71500", "71100", "71300", "72550", "72150", "72350", "72920", "76100", "72960", "76200", "74100", "72670", "72750", "76300", "72970", "72830", "72930", "73030", "76400", "75300", "72600", "72200", "72400", "72680", "72760", "72840", "72690", "72770", "72850", "76500", "75100", "72650", "72250", "76600", "74200", "72450", "72940", "76700", "74300", "71600", "71200", "71400", "75200", "72980", "73700", "72700", "72780", "72990", "72860", "73600", "73200", "73400", "72710", "72790", "73000", "72870", "72720", "72800", "73010", "72880", "76900", "75500", "72731", "72811", "72730", "72810", "73020", "72890", "40100", "40400", "40200", "40300", "30100", "30200", "30300", "30400", "30500", "30600", "30700", "30800", "30900", "31000", "31100", "31200", "50300", "50200", "50100" ], "type": "string", "description": "Narrow further to one of HKEX's 293 detailed document sub-types within a headline category (e.g. \"Allotment Results\" within \"Announcements and Notices\"). Automatically fills in the matching headline category if left as \"All categories\"; overrides a conflicting headlineCategory selection with a warning. Leave as \"All sub-categories\" for no sub-type filter.", "default": "" }, "market": { "title": "Market / board", "enum": [ "SEHK", "GEM" ], "type": "string", "description": "Which HKEX board to search. Main Board (SEHK) lists the large-cap/established issuers; GEM (Growth Enterprise Market) lists smaller-cap issuers under lighter admission requirements.", "default": "SEHK" }, "titleKeyword": { "title": "Title contains keyword", "type": "string", "description": "Only return announcements whose title contains this word (case-insensitive, single word works best)." }, "dateFrom": { "title": "Date from", "type": "string", "description": "Earliest release date, `YYYY-MM-DD`. HKEX only allows a ~30-day window unless a specific stock code is set (a headline category alone does not widen it), in which case the window extends to ~366 days. Defaults to 30 days before `dateTo`." }, "dateTo": { "title": "Date to", "type": "string", "description": "Latest release date, `YYYY-MM-DD`. Defaults to today." }, "sortBy": { "title": "Sort by", "enum": [ "latest", "oldest", "stockCodeAsc", "stockCodeDesc", "nameAsc", "nameDesc" ], "type": "string", "description": "Order of returned announcements.", "default": "latest" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Hard cap on emitted records.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Only used as an automatic fallback if HKEXnews starts rate-limiting the datacenter IP. Leave the default AUTO group enabled — no paid proxy is required.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }