{
  "openapi": "3.0.1",
  "info": {
    "title": "HKEX Scraper | Announcements and Filings",
    "description": "HKEX scraper for HKEXnews (披露易, 港交所) announcements and filings of Hong Kong listed companies: 60 announcements from 3 stock codes in 6 seconds, 19 fields each. Get category codes, stock codes, publication time, document link, file size and full text. Filter by date, category, keyword and language.",
    "version": "1.0",
    "x-build-id": "tf86LlWfywCg91CWe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~hkex-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-hkex-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/silentflow~hkex-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-hkex-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/silentflow~hkex-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-hkex-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": {
          "stockCodes": {
            "title": "📈 Stock codes",
            "type": "array",
            "description": "HKEX stock codes to follow, one per line: <code>00700</code>, <code>700</code>, <code>0700.HK</code> or a quote page link from hkex.com.hk. Each code returns its announcements newest first, up to <b>Max announcements</b> per code, from the whole archive (back to 1999) unless you set dates. Main Board, GEM and delisted codes all work.<br><br>Leave empty, with no links, to read the whole market.",
            "items": {
              "type": "string"
            }
          },
          "announcementUrls": {
            "title": "🔗 Announcement links",
            "type": "array",
            "description": "HKEXnews document links, such as <code>https://www1.hkexnews.hk/listedco/listconews/sehk/2026/1118/2026111800448.pdf</code>. Each link returns its announcement with every detail, whatever the cap. Links to one file of a multi-document announcement work too. Chinese links (ending in <code>_c</code>) return the Chinese row.",
            "items": {
              "type": "string"
            }
          },
          "dateFrom": {
            "title": "📅 Published from",
            "type": "string",
            "description": "First publication day, Hong Kong time. A date (<code>2026-11-01</code>) or a delay back from today such as <code>7 days</code> or <code>1 month</code>, handy for scheduled runs. Empty: the whole archive for stock codes, yesterday for the whole market."
          },
          "dateTo": {
            "title": "📅 Published to",
            "type": "string",
            "description": "Last publication day, Hong Kong time, a date or a delay back from today. Empty: today."
          },
          "categories": {
            "title": "🗂️ Categories",
            "type": "array",
            "description": "Keep only these HKEXnews headline categories. Empty: every category. Each row also carries its subcategory (Inside Information, Share Buyback, Final Results...) with its code.",
            "items": {
              "type": "string",
              "enum": [
                "10000",
                "20000",
                "30000",
                "40000",
                "50000",
                "51500",
                "52000",
                "53000",
                "54000",
                "55000",
                "56000",
                "70000",
                "80000",
                "81000",
                "90000",
                "91000",
                "57000",
                "58000",
                "59000",
                "51000"
              ],
              "enumTitles": [
                "Announcements and Notices",
                "Circulars",
                "Listing Documents",
                "Financial Statements/ESG Information",
                "Next Day Disclosure Returns",
                "Monthly Returns",
                "Proxy Forms",
                "Company Information Sheet",
                "Constitutional Documents",
                "Takeovers Code - dealing disclosures",
                "Documents on Display",
                "Debt and Structured Products",
                "Trading Information of Exchange Traded Funds",
                "Trading Information of Leveraged and Inverse Products",
                "Regulatory Announcement & News",
                "Application Proofs, OC Announcements and PHIPs",
                "Documents on Display (Debt Issuance Programmes)",
                "Documents on Display (Debt Securities)",
                "Documents on Display (Structured Products)",
                "Share Buyback Reports (Before 1 January 2009)"
              ]
            }
          },
          "keyword": {
            "title": "🔎 Title keyword",
            "type": "string",
            "description": "Keep announcements whose title contains these words, such as <code>profit warning</code>, <code>buy-back</code> or <code>connected transaction</code>. Matching is done by HKEXnews on the title only."
          },
          "language": {
            "title": "🌐 Language",
            "enum": [
              "en",
              "zh"
            ],
            "type": "string",
            "description": "English or Traditional Chinese: titles, stock names, categories and the document link all follow. A few issuers publish some documents in one language only.",
            "default": "en"
          },
          "maxItems": {
            "title": "🔢 Max announcements",
            "minimum": 1,
            "type": "integer",
            "description": "Most announcements per stock code, or in total for the whole-market search. Links always return every announcement. Tencent alone has more than 1,800 announcements in the archive, a busy market day about 650.",
            "default": 100
          },
          "includeContent": {
            "title": "📄 Document text",
            "type": "boolean",
            "description": "Add the text of each PDF and HTML document in <code>content</code> (first 500,000 characters), ready for search, NLP and AI tools. Spreadsheets keep their link only, and multi-document announcements list their files in <code>attachments</code>. Slower: every document is downloaded.",
            "default": false
          },
          "debugMode": {
            "title": "🐞 Debug mode",
            "type": "boolean",
            "description": "Show detailed logs.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}