{
  "openapi": "3.0.1",
  "info": {
    "title": "HKEX News API – Announcements, Director Dealings & CCASS",
    "description": "Hong Kong Exchange (HKEX) data as JSON: HKEXnews announcements with category, title and document link; director and substantial-shareholder dealings (disclosure of interests); CCASS shareholding by participant. Stock-code watchlists, only-new feed. $3 per 1,000 filings, $1 per 1,000 CCASS rows.",
    "version": "0.1",
    "x-build-id": "BPVzRZDAKZphd94oM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/data_daemon~hkex-news-filings/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-data_daemon-hkex-news-filings",
        "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/data_daemon~hkex-news-filings/runs": {
      "post": {
        "operationId": "runs-sync-data_daemon-hkex-news-filings",
        "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/data_daemon~hkex-news-filings/run-sync": {
      "post": {
        "operationId": "run-sync-data_daemon-hkex-news-filings",
        "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": {
          "reports": {
            "title": "Reports",
            "type": "array",
            "description": "Which HKEX feeds to read. Each row carries its `reportType`. `announcements` (default): listed-company announcements, circulars, results, next-day disclosure returns and other documents from the HKEXnews title search, with stock codes, headline category and document link (687 entries on Friday 13 November 2026). `directorDealings`: disclosure-of-interests notices filed by directors, chief executives and substantial shareholders (who, shares bought or sold, average price, holding and percent afterwards; 626 notices for the event days 9-13 November 2026). `ccassHoldings`: CCASS participant shareholding of each stock in `stockCodes` on one day (which broker or custodian holds how many shares and what percent of the issued shares; 416 participants for Tencent on 13 November 2026).",
            "items": {
              "type": "string",
              "enum": [
                "announcements",
                "directorDealings",
                "ccassHoldings"
              ],
              "enumTitles": [
                "Announcements (HKEXnews title search: category, title, document)",
                "Director and shareholder dealings (disclosure of interests)",
                "CCASS shareholding by participant (needs stock codes)"
              ]
            },
            "default": [
              "announcements"
            ]
          },
          "stockCodes": {
            "title": "Stock codes",
            "type": "array",
            "description": "HKEX stock codes to keep, with or without leading zeros: `00700`, `700`, `5`, `09988`. The spellings other tools use (`0700.HK`, `HKEX:700`) and HKEXnews short names (`TENCENT`) work too. Empty = the whole market for announcements and dealings. **Required for `ccassHoldings`**, which is searched one stock at a time. With stock codes, announcements and dealings are read per company, so a year of history for a watchlist is a small run.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "headlineCategories": {
            "title": "Headline categories (announcements)",
            "type": "array",
            "description": "Keep announcements of these HKEX headline categories. Exact names are filtered by HKEXnews itself, which makes long histories cheap: tier one such as `Announcements and Notices`, `Circulars`, `Financial Statements/ESG Information`, `Next Day Disclosure Returns`, `Monthly Returns`, `Listing Documents`, or a subcategory such as `Final Results`, `Interim Results`, `Profit Warning`, `Inside Information`, `Dividend or Distribution`, `Share Buyback`, `Trading Halt`. Any other text is matched as words in the category of each row. Empty = everything HKEXnews lists, including fund trading information and structured-product notices.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Keep rows that contain one of these words (case-insensitive). Announcements: title, stock name and category (`placing`, `privatisation`, `profit warning`). Dealings: company, holder name and reason (`BlackRock`, `purchased`). CCASS: participant name or ID (`HSBC`, `C00019`). Empty = all.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "daysBack": {
            "title": "Days back",
            "minimum": 0,
            "maximum": 3660,
            "type": "integer",
            "description": "For announcements and dealings: how many days before today (Hong Kong time) to read, today included. `0` = today only, `7` (default) = today and the seven days before. Ignored when From date is set. Dealings are searched by the date of the event, and a notice can be filed some days after it: read at least 5 days back in a daily feed.",
            "default": 7
          },
          "fromDate": {
            "title": "From date",
            "type": "string",
            "description": "First day (YYYY-MM-DD, Hong Kong time) for announcements and dealings. Use with To date for a backfill; the week of 9-13 November 2026 had 3,283 entries."
          },
          "toDate": {
            "title": "To date",
            "type": "string",
            "description": "Last day (YYYY-MM-DD, Hong Kong time). Empty = today."
          },
          "language": {
            "title": "Language (announcements)",
            "enum": [
              "en",
              "zh",
              "both"
            ],
            "type": "string",
            "description": "HKEXnews files the English and the Chinese version of a document as separate entries with their own ids. `en` (default) reads the English entries, `zh` the Chinese ones (titles and categories in Chinese), `both` reads both and marks each row with its `language`.",
            "default": "en"
          },
          "includeDetails": {
            "title": "Open each dealing notice (stock code, holding before)",
            "type": "boolean",
            "description": "For `directorDealings`: open the notice page of every delivered row and add the stock code, the share class, the number of issued shares, the holding and percent before the event, the change, the capacity and the highest price. One more request per notice (about three seconds each), so it is off by default. Not needed for the stock code when `stockCodes` is set: those rows carry it already.",
            "default": false
          },
          "holdingDate": {
            "title": "CCASS holding date",
            "type": "string",
            "description": "For `ccassHoldings`: the day whose holdings to read (YYYY-MM-DD). Empty = the latest day CCASS serves (the day before today). CCASS serves the past 12 months; for a Sunday or public holiday it answers with the day before, and the rows say which day they are."
          },
          "topParticipants": {
            "title": "CCASS participants per stock",
            "minimum": 0,
            "type": "integer",
            "description": "For `ccassHoldings`: keep the largest N participants of each stock, by shares held. Default 50. `0` = every participant (416 rows for Tencent on 13 November 2026). Each stock also returns one summary row with the totals.",
            "default": 50
          },
          "minPercent": {
            "title": "CCASS minimum percent",
            "type": "string",
            "description": "For `ccassHoldings`: keep participants that hold at least this percent of the issued shares, for example `1` or `0.5`. Empty or `0` = no minimum."
          },
          "compareDays": {
            "title": "CCASS compare with N days earlier",
            "minimum": 0,
            "maximum": 365,
            "type": "integer",
            "description": "For `ccassHoldings`: also read the holdings N days before the holding date and add `previousShares`, `sharesChange` and `percentOfIssuedChange` to every row (who added, who reduced). One more request per stock. `0` (default) = no comparison.",
            "default": 0
          },
          "maxItems": {
            "title": "Maximum rows per report",
            "minimum": 0,
            "type": "integer",
            "description": "Stop announcements and dealings after this many rows each, newest first. `0` = no limit. Each of these rows costs $0.003, so the default 50 rows cost $0.15. CCASS rows are limited by Participants per stock instead.",
            "default": 50
          },
          "onlyNew": {
            "title": "Only new rows (daily feed)",
            "type": "boolean",
            "description": "Remember what was delivered and return only rows that are new since the last run with the same state name. Rows already delivered are skipped and not charged again, so a scheduled run with Days back 7 never misses a late notice and never bills one twice. For CCASS a day's holdings of a stock are delivered once.",
            "default": false
          },
          "stateName": {
            "title": "State name",
            "type": "string",
            "description": "Name of the only-new memory. Use a different name for each independent feed (for example one per watchlist). Letters, digits, dash and underscore.",
            "default": "default"
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. The HKEX pages answer Apify datacenter addresses without a proxy (checked 16 Nov 2026), so none is used by default."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}