/hkexnews/announcements/search

POST /api/hkexnews/announcements/search

Price: 5 credits

Search documents published on HKEXnews by companies listed on the Hong Kong Exchange (Main Board and GEM): announcements, circulars, financial statements, listing documents, monthly and next-day returns and more. Filter by issuer, title words, release window, headline category or document type. Each row is the document's id, title, release time, file link, headline categories and the securities it concerns.

How to use it

Pass stock_code to search one issuer's whole filing history; without it the search covers every issuer, current and delisted, and, unless published_from is set, only the last 365 days. document_type classifies filings released up to June 2007 and the headline filters classify later filings, so pick the one matching the period. Pass language=zh for the Chinese versions, which carry their own ids and links.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of announcements to return (min: 1; max: 10000)
• stock_code string nullable — HKEX stock code of the issuer (examples: "00700", "5"; minLength: 1; maxLength: 5)
• keyword string nullable — Words to find in document titles (examples: "annual results", "dividend"; minLength: 1)
• published_from integer nullable — Earliest release day, as unix seconds; day-granular (examples: 1735689600)
• published_to integer nullable — Latest release day, as unix seconds; day-granular (examples: 1759190400)
• headline_category string nullable — Top-level headline category of the document (one of: "announcements_and_notices", "circulars", "listing_documents", "financial_statements_esg", "next_day_disclosure_returns", "monthly_returns", "proxy_forms", "company_information_sheet", "etf_trading_information", "leveraged_inverse_products_trading_information", "constitutional_documents", "documents_on_display", "regulatory_announcements_news", "takeovers_code_dealing_disclosures", "debt_structured_products", "documents_on_display_debt_issuance_programmes", "documents_on_display_debt_securities", "documents_on_display_structured_products", "application_proofs_phips", "share_buyback_reports_before_2009")
• headline_group string nullable — Headline group inside a top-level category (one of: "debt_structured_callable_bull_bear_contracts_cbbc", "circular_connected_transaction", "announcement_connected_transactions", "announcement_corporate_positions_and_corporate_changes", "circular_corporate_positions_and_corporate_changes", "debt_structured_debt_issuance_programmes", "debt_structured_debt_securities", "debt_structured_derivative_warrants_dw", "debt_structured_equity_linked_instruments_eli", "announcement_financial_information", "debt_structured_information_regarding_products_issuers", "announcement_meetings_voting", "circular_meetings_voting", "announcement_miscellaneous", "circular_miscellaneous", "announcement_new_listings_listed_new_applicants", "announcement_notifiable_transactions", "circular_notifiable_transactions", "circular_reorganisation_change_in_listing_status", "announcement_reorganisation_change_in_listing_status", "announcement_securities_share_capital", "circular_securities_share_capital")
• headline_subcategory string nullable — Detailed headline category of the document (one of: "auditors_or_ineds_unable_to_connected_transaction", "announcement_connected_transaction", "announcement_continuing_connected_transaction", "guaranteed_net_tangible_assets_or_profits", "waiver_in_respect_of_transaction_requirements", "change_in_company_website", "announcement_amendment_of_constitutional_documents", "change_in_auditors", "change_in_class_rights", "change_in_compliance_adviser", "change_in_compliance_officer", "change_in_directors_or_of_or_responsibilities", "change_in_financial_year_end", "change_in_qualified_accountant_before_1_january_2009", "change_in_registered_address_or_office_in_hk", "change_in_company_secretary", "change_in_supervisors", "change_of_audit_committee_member", "change_of_company_name", "non_compliance_with_audit_committee_requirements", "non_compliance_with_compliance_officer_requirements", "non_compliance_with_ined_independence_guidelines", "non_compliance_with_qualified_accountant_january_2009", "change_in_a_directors_or_biographical_details", "change_in_chief_executive", "list_of_directors_and_their_role_and_function", "non_compliance_with_committee_requirements", "terms_of_reference_of_the_audit_committee", "terms_of_reference_of_the_nomination_committee", "terms_of_reference_of_the_remuneration_committee", "change_of_remuneration_committee_member", "terms_of_reference_of_other_board_committees", "change_in_share_registrar_transfer_agent", "change_of_nomination_committee_member", "non_compliance_with_nomination_committee_requirements", "advance_to_an_entity", "date_of_board_meeting", "delay_in_results_announcement", "dividend_or_distribution", "dividend_or_distribution_announcement_form", "final_results", "financial_assistance_and_or_affiliated_company", "interim_results", "net_asset_value", "profit_warning", "modified_report_by_auditors", "quarterly_results", "results_of_a_subsidiary", "revision_of_information_in_preliminary_results", "prior_period_adjustments_due_to_material_errors", "revision_of_published_financial_statements_and_reports", "announcement_change_of_voting_intention", "announcement_material_information_after_of_circular", "announcement_nomination_of_director_by_shareholder", "notice_of_agm", "notice_of_egm_sgm", "announcement_re_election_or_shareholders_approval", "results_of_agm", "results_of_egm_sgm", "results_of_voting_by_poll_before_1_january_2009", "announcement_change_in_auditors_shareholders_approval", "allotment_results", "formal_notice", "listing_of_securities_by_way_of_introduction", "striking_price_on_offer_for_subscription_or_by_tender", "supplemental_information_regarding_ipo", "transfer_of_listing_from_gem_to_main_board", "mixed_media_offer", "delay_in_completion", "discloseable_transaction", "announcement_major_transaction", "announcement_reverse_takeover", "share_transaction", "termination_of_transaction", "variation_to_terms", "announcement_very_substantial_acquisition", "announcement_very_substantial_disposal", "announcement_by_offeree_company_under_takeovers_code", "announcement_by_offeror_company_under_takeovers_code", "change_in_shareholding", "charging_or_pledging_of_shares_by_shareholder", "concentration_of_shareholdings", "dealing_in_securities_by_director_where_model_code", "fundamental_change_in_principal_business_january_2009", "group_restructuring_or_scheme_of_arrangement", "lack_of_open_market_in_securities", "listing_on_overseas_exchange_or_securities_market", "privatisation_withdrawal_or_cancellation_of_securities", "resumption", "announcement_spin_off", "sufficiency_of_assets_and_or_operations_cash_company", "sufficiency_of_public_float", "suspension", "winding_up_and_liquidation_of_issuer_major_subsidiary", "change_in_principal_business_activities", "trading_halt", "announcement_pursuant_to_code_on_share_buy_backs", "bonus_issue_announcement_form", "capital_reorganisation", "announcement_capitalisation_issue", "change_in_board_lot_size", "announcement_change_in_terms_of_to_securities", "change_of_dividend_payment_date", "closure_of_books_or_change_of_book_closure_period", "consideration_issue", "conversion_of_securities", "intention_to_sell_shares_of_untraceable_member", "announcement_issue_of_convertible_securities", "announcement_issue_of_debt_securities", "announcement_issue_of_preference_shares", "announcement_issue_of_securities_by_major_subsidiary", "issue_of_shares_under_a_general_mandate", "issue_of_shares_under_a_specific_mandate", "announcement_issue_of_warrants", "movements_in_issued_share_capital", "announcement_open_offer", "placing", "announcement_rights_issue", "announcement_share_scheme", "trading_arrangements_other_than_change_in_lot_size", "sale_or_transfer_of_treasury_shares_general_mandate", "sale_or_transfer_of_treasury_shares_specific_mandate", "breach_of_loan_agreement", "clarification_of_news_or_reports_qualified", "clarification_of_news_or_reports_standard_or_super", "delay_in_dispatch_of_circular_or_other_document", "loan_agreement_with_specific_performance_covenant", "matters_relating_to_options", "announcement_matters_relating_to_investment_schemes", "other_before_1_april_2014", "overseas_regulatory_announcement_before_1_april_2014", "price_sensitive_information_before_1_january_2013", "unusual_price_turnover_movements_qualified", "unusual_price_turnover_movements_standard_or_super", "mining_activities_undertaken_by_listed_issuers", "inside_information", "other_business_update", "other_corporate_governance_related_matters", "other_litigation", "other_miscellaneous", "other_trading_update", "overseas_regulatory_announcement_board_resolutions", "overseas_regulatory_announcement_business_update", "overseas_regulatory_announcement_related_matters", "overseas_regulatory_announcement_issue_related_matters", "overseas_regulatory_announcement_other", "overseas_regulatory_announcement_trading_update", "overseas_regulatory_announcement_sale_related_matters", "circular_connected_transaction", "circular_continuing_connected_transaction", "circular_amendment_of_constitutional_documents", "circular_change_of_voting_intention", "circular_material_information_after_issue_of_circular", "circular_nomination_of_director_by_shareholder", "circular_re_election_or_shareholders_approval", "circular_change_in_auditors_shareholders_approval", "discloseable_transaction_before_1_january_2009", "circular_major_transaction", "circular_reverse_takeover", "circular_very_substantial_acquisition", "circular_very_substantial_disposal", "document_issued_by_offeree_company_takeovers_code", "document_issued_by_offeror_company_takeovers_code", "fundamental_change_in_principal_business_activities", "privatisation_withdrawal_of_listing_of_securities", "proposal_of_mineral_company_to_existing_activities", "circular_spin_off", "circular_capitalisation_issue", "circular_change_in_terms_of_securities_to_securities", "document_issued_pursuant_to_code_on_share_buy_backs", "circular_exchange_or_substitution_of_securities", "explanatory_statement_for_repurchase_of_shares", "general_mandate", "circular_issue_of_convertible_securities", "circular_issue_of_debt_securities", "circular_issue_of_preference_shares", "circular_issue_of_securities_by_major_subsidiary", "issue_of_securities_within_6_months_of_listing", "issue_of_shares", "circular_issue_of_warrants", "circular_open_offer", "circular_rights_issue", "circular_share_scheme", "sale_or_transfer_of_treasury_shares_within_of_listing", "sale_or_transfer_of_treasury_shares", "circular_matters_relating_to_investment_schemes", "circular_other", "authorised_collective_investment_scheme", "listing_document_capitalisation_issue", "deemed_new_listing_under_the_listing_rules", "listing_document_exchange_or_of_securities", "introduction", "offer_for_sale", "offer_for_subscription", "listing_document_open_offer", "listing_document_other", "placing_of_securities_of_a_class_new_to_listing", "listing_document_rights_issue", "supplementary_listing_document", "annual_report", "interim_half_year_report", "quarterly_report", "environmental_social_and_governance_information_report", "share_buyback", "others", "on_market_sale_of_treasury_shares", "daily_trading_report_dw", "pre_listing_trading_report_dw", "daily_trading_report_eli", "pre_listing_trading_report_eli", "daily_trading_report_cbbc", "pre_listing_trading_report_cbbc", "additional_information_exotic_dw", "expiry_announcement_dw", "launch_announcement_dw", "other_dw", "additional_information_exotic_eli", "expiry_announcement_eli", "launch_announcement_eli", "other_eli", "additional_information_exotic_cbbc", "expiry_announcement_cbbc", "launch_announcement_cbbc", "other_cbbc", "adjustment_to_terms_and_conditions_cbbc", "adjustment_to_terms_and_conditions_form_cbbc", "inside_information_cbbc", "liquidity_provision_service_cbbc", "market_disruption_event_cbbc", "resumption_cbbc", "suspension_cbbc", "trading_halt_cbbc", "withdrawal_of_listing_cbbc", "withdrawal_of_listing_announcement_form_cbbc", "adjustment_to_terms_and_conditions_dw", "adjustment_to_terms_and_conditions_form_dw", "inside_information_dw", "liquidity_provision_service_dw", "market_disruption_event_dw", "resumption_dw", "suspension_dw", "trading_halt_dw", "withdrawal_of_listing_dw", "withdrawal_of_listing_announcement_form_dw", "adjustment_to_terms_and_conditions_eli", "inside_information_eli", "liquidity_provision_service_eli", "market_disruption_event_eli", "resumption_eli", "suspension_eli", "trading_halt_eli", "withdrawal_of_listing_eli", "corporate_information_structured_products_issuer", "credit_rating_structured_products_issuer", "financial_disclosure_or_report_products_issuer", "inside_information_structured_products_issuer", "other_structured_products_issuer", "adjustment_to_terms_and_conditions_debt_securities", "financial_report_debt_securities", "inside_information_debt_securities", "redemption_or_repurchase_debt_securities", "resumption_debt_securities", "suspension_debt_securities", "trading_halt_debt_securities", "withdrawal_of_listing_debt_securities", "interest_payment_announcement_form_debt_securities", "base_listing_document_dw", "supplemental_listing_document_dw", "base_listing_document_eli", "supplemental_listing_document_eli", "base_listing_document_cbbc", "supplemental_listing_document_cbbc", "residual_value_announcement_form_cbbc", "formal_notice_debt_securities", "other_debt_securities", "overseas_regulatory_announcement_debt_securities", "offering_circular_and_pricing_debt_securities", "prospectus_debt_securities", "issuer_specific_report_debt_securities", "clarification_of_news_or_reports_debt_securities", "unusual_price_turnover_movements_debt_securities", "financial_report_debt_issuance_programmes", "formal_notice_debt_issuance_programmes", "inside_information_debt_issuance_programmes", "issuer_specific_report_debt_issuance_programmes", "offering_circular_debt_issuance_programmes", "other_debt_issuance_programmes", "overseas_regulatory_announcement_issuance_programmes", "clarification_of_news_or_reports_issuance_programmes", "unusual_price_turnover_movements_issuance_programmes", "post_hearing_information_packs_or_related_materials", "application_proofs_or_related_materials", "oc_announcements_or_related_materials")
• document_type string nullable — Document type (one of: "announcement", "ipo_allotment_results", "results_announcement", "financial_statements", "securities_buyback", "information_table", "trading_arrangement", "changes_in_directorships", "notices_of_general_meetings", "proxy_form", "results_of_general_meetings", "company_profile_gem_only", "others", "efn_tender_notice", "circulars", "prospectuses", "base_listing_document")
• gem_only boolean — Keep only documents of GEM-listed issuers (default: false)
• language string — Language of the documents (default: "en"; one of: "en", "zh")
• sort string — Order by release time (default: "newest"; one of: "newest", "oldest")

Response

• @type string (default: "HkexnewsAnnouncement")
• id string required
• name string nullable
• url string nullable
• published_at integer nullable
• file_format string nullable
• file_size string nullable
• headline_categories array (default: [])
• securities array (default: [])
  • @type string (default: "HkexnewsAnnouncementSecurity")
  • stock_code string nullable
  • stock_name string nullable
• language string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No security under that stock_code, current or delisted Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.