API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/ibpgsbp/list-outstanding-govbonds-ibpgsbpRequest Parameters (Mandatory)
| Parameter Name | Description |
|---|---|
| segment |
Used to indicate which sets of data are going to
retrieve. Format: segment=data segment name (Outstanding/Matured) Example: segment=Outstanding |
Outstanding
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| expected_maturity_date | Date | yyyy-mm-dd | Expected maturity date Date in ISO format yyyy-mm-dd |
| original_maturity | String | Original maturity | |
| isin_code_regs | String | ISIN code (Reg S) | |
| isin_code_144a | String | ISIN code (144A) | |
| issue_code | String | Issue code | |
| stock_code | String | Stock code | |
| coupon | Number | % per annum | Coupon |
| Currency | String | Currency | |
| outstanding_size | Number | billion | Outstanding size |
| institutional_retail | String | Institutional/ Retail | |
| Bond_programme | String | Bond Programme |
Matured
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| maturity_date | Date | yyyy-mm-dd | Maturity date Date in ISO format yyyy-mm-dd |
| original_maturity | String | Original maturity | |
| isin_code_regs | String | ISIN code (Reg S) | |
| isin_code_144a | String | ISIN code (144A) | |
| issue_code | String | Issue code | |
| stock_code | String | Stock code | |
| coupon | Number | % per annum | Coupon |
| currency | String | Currency | |
| size | Number | billion | size |
| institutional_retail | String | Institutional/ Retail | |
| Bond_programme | String | Bond Programme |