feat: get the announcement information

NAMESPACE

@@ -45,6 +45,7 @@ export(lxr_cn_company_shareholders_num)
 export(lxr_cn_company_suppliers)
 export(lxr_cn_company_trading_abnormal)
 export(lxr_hk_company)
+export(lxr_hk_company_announcement)
 export(lxr_hk_company_candlestick)
 export(lxr_hk_company_employee)
 export(lxr_hk_company_fundamental_statistics)

R/hk-company.R

@@ -20,6 +20,7 @@
 #'   belongs to.
 #' * `lxr_hk_company_fundamental_statistics()` get fundamental analysis
 #'   statistical data.
+#' * `lxr_hk_company_announcement()` get the announcement information.
 #'
 #' @return A string of the API endpoint.
 
@@ -76,3 +77,9 @@ lxr_hk_company_industries <- function() {
 lxr_hk_company_fundamental_statistics <- function() {
   "https://open.lixinger.com/api/hk/company/fundamental-statistics"
 }
+
+#' @rdname lxr_hk_company
+#' @export
+lxr_hk_company_announcement <- function() {
+  "https://open.lixinger.com/api/hk/company/announcement"
+}

R/query-params.R

@@ -148,6 +148,7 @@ lxr_query_params <- function(endpoint) {
     hk_company_fundamental_statistics = list(
       valid_params = c("stockCodes", "granularity", "metricsList"),
       required_params = c("stockCodes", "granularity", "metricsList")
-    )
+    ),
+    hk_company_announcement = common_params
   )
 }

tests/testthat/test-hk-company.R

@@ -91,3 +91,14 @@ test_that("test hk_company_fundamental_statistics", {
   expect_s3_class(result, "tbl_df")
   expect_true(nrow(result) > 0)
 })
+
+test_that("test hk_company_announcement", {
+  result <- lxr_query(
+    endpoint = lxr_hk_company_announcement(),
+    start_date = "2023-01-03",
+    end_date = "2024-02-03",
+    stock_code = "00700"
+  )
+  expect_s3_class(result, "tbl_df")
+  expect_true(nrow(result) > 0)
+})