API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/ibpgsbp/instit-bond-price-yield-daily-ibpgsbp-rmbRequest Parameters (Mandatory)
| Parameter Name | Description |
|---|---|
| segment | Specifies which daily dataset segment to retrieve. Supported values are Benchmark Format: string Example: Benchmark |
Benchmark
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| daily_figure | Date | Daily figures Year | |
| ind_pricing_1y | Number | percent per annum | Benchmark yields Indicative Pricings 1-year |
| ind_pricing_2y | Number | percent per annum | Benchmark yields Indicative Pricings 2-year |
| ind_pricing_3y | Number | percent per annum | Benchmark yields Indicative Pricings 3-year |
| ind_pricing_5y | Number | percent per annum | Benchmark yields Indicative Pricings 5-year |
| ind_pricing_7y | Number | percent per annum | ind_pricing_7y |
| ind_pricing_10y | Number | percent per annum | Benchmark yields Indicative Pricings 10-year |
| closing_ref_rate_1y | Number | percent per annum | Benchmark yields Closing Reference Rates 1-year |
| closing_ref_rate_2y | Number | percent per annum | Benchmark yields Closing Reference Rates 2-year |
| closing_ref_rate_3y | Number | percent per annum | Benchmark yields Closing Reference Rates 3-year |
| closing_ref_rate_5y | Number | percent per annum | Benchmark yields Closing Reference Rates 5-year |
| closing_ref_rate_7y | Number | percent per annum | Benchmark yields Closing Reference Rates 7-year |
| closing_ref_rate_10y | Number | percent per annum | Benchmark yields Closing Reference Rates 10-year |
Footnotes:
| 1. Figures powered by Bloomberg. |
| 2. Calculation method and further information are set out in the Reference Manual of Indicative Pricings under Infrastructure Bond Programme and Government Sustainable Bond Programme (https://www.hkgb.gov.hk/en/others/documents/ReferenceManualForInstitutionalGovernmentBondIndicativePricings_IBPandGSBP.pdf). |
| 3. Indicative yields are provided for reference only. Exact yields may vary depending on the applicable settlement arrangement and calculation methodology. |
OutstandPrices
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| daily_figure | Date | Daily figures Year | |
| ind_pricing_01gb2607001 | Number | Indicative Pricings 01GB2607001 | |
| ind_pricing_01gb2612001 | Number | Indicative Pricings 01GB2612001 | |
| ind_pricing_02gb2611001 | Number | Indicative Pricings 02GB2611001 | |
| ind_pricing_02gb2705001 | Number | Indicative Pricings 02GB2705001 | |
| ind_pricing_02gb2708001 | Number | Indicative Pricings 02GB2708001 | |
| ind_pricing_02gb2711001 | Number | Indicative Pricings 02GB2711001 | |
| ind_pricing_03gb2710002 | Number | Indicative Pricings 03GB2710002 | |
| ind_pricing_03gb2807001 | Number | Indicative Pricings 03GB2807001 | |
| ind_pricing_05gb2912002 | Number | Indicative Pricings 05GB2912002 | |
| ind_pricing_05gb3005001 | Number | Indicative Pricings 05GB3005001 | |
| ind_pricing_05gb3105001 | Number | Indicative Pricings 05GB3105001 | |
| ind_pricing_07gb3306001 | Number | Indicative Pricings 07GB3306001 | |
| ind_pricing_10gb3411001 | Number | Indicative Pricings 10GB3411001 | |
| ind_pricing_10gb3505001 | Number | Indicative Pricings 10GB3505001 | |
| closing_ref_rate_01gb2603001 | Number | Closing Reference Rates 01GB2603001 | |
| closing_ref_rate_01gb2604001 | Number | Closing Reference Rates 01GB2604001 | |
| closing_ref_rate_01gb2607001 | Number | Closing Reference Rates 01GB2607001 | |
| closing_ref_rate_01gb2612001 | Number | Closing Reference Rates 01GB2612001 | |
| closing_ref_rate_02gb2611001 | Number | Closing Reference Rates 02GB2611001 | |
| closing_ref_rate_02gb2705001 | Number | Closing Reference Rates 02GB2705001 | |
| closing_ref_rate_02gb2708001 | Number | Closing Reference Rates 02GB2708001 | |
| closing_ref_rate_02gb2711001 | Number | Closing Reference Rates 02GB2711001 | |
| closing_ref_rate_03gb2710002 | Number | Closing Reference Rates 03GB2710002 | |
| closing_ref_rate_03gb2807001 | Number | Closing Reference Rates 03GB2807001 | |
| closing_ref_rate_05gb2912002 | Number | Closing Reference Rates 05GB2912002 | |
| closing_ref_rate_05gb3005001 | Number | Closing Reference Rates 05GB3005001 | |
| closing_ref_rate_10gb3411001 | Number | Closing Reference Rates 10GB3411001 | |
| closing_ref_rate_10gb3505001 | Number | Closing Reference Rates 10GB3505001 |
OutstandYields
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| daily_figure | Date | Daily figures Year | |
| ind_pricing_01gb2607001 | Number | Indicative Pricings 01GB2607001 | |
| ind_pricing_01gb2612001 | Number | Indicative Pricings 01GB2612001 | |
| ind_pricing_02gb2611001 | Number | Indicative Pricings 02GB2611001 | |
| ind_pricing_02gb2705001 | Number | Indicative Pricings 02GB2705001 | |
| ind_pricing_02gb2708001 | Number | Indicative Pricings 02GB2708001 | |
| ind_pricing_02gb2711001 | Number | Indicative Pricings 02GB2711001 | |
| ind_pricing_03gb2710002 | Number | Indicative Pricings 03GB2710002 | |
| ind_pricing_03gb2807001 | Number | Indicative Pricings 03GB2807001 | |
| ind_pricing_05gb2912002 | Number | Indicative Pricings 05GB2912002 | |
| ind_pricing_05gb3005001 | Number | Indicative Pricings 05GB3005001 | |
| ind_pricing_05gb3105001 | Number | Indicative Pricings 05GB3105001 | |
| ind_pricing_07gb3306001 | Number | Indicative Pricings 07GB3306001 | |
| ind_pricing_10gb3411001 | Number | Indicative Pricings 10GB3411001 | |
| ind_pricing_10gb3505001 | Number | Indicative Pricings 10GB3505001 | |
| closing_ref_rate_05gb3105001 | Number | Closing Reference Rates 05GB3105001 | |
| closing_ref_rate_07gb3306001 | Number | Closing Reference Rates 07GB3306001 | |
| closing_ref_rate_01gb2607001 | Number | Closing Reference Rates 01GB2607001 | |
| closing_ref_rate_01gb2612001 | Number | Closing Reference Rates 01GB2612001 | |
| closing_ref_rate_02gb2611001 | Number | Closing Reference Rates 02GB2611001 | |
| closing_ref_rate_02gb2705001 | Number | Closing Reference Rates 02GB2705001 | |
| closing_ref_rate_02gb2708001 | Number | Closing Reference Rates 02GB2708001 | |
| closing_ref_rate_02gb2711001 | Number | Closing Reference Rates 02GB2711001 | |
| closing_ref_rate_03gb2710002 | Number | Closing Reference Rates 03GB2710002 | |
| closing_ref_rate_03gb2807001 | Number | Closing Reference Rates 03GB2807001 | |
| closing_ref_rate_05gb2912002 | Number | Closing Reference Rates 05GB2912002 | |
| closing_ref_rate_05gb3005001 | Number | Closing Reference Rates 05GB3005001 | |
| closing_ref_rate_10gb3411001 | Number | Closing Reference Rates 10GB3411001 | |
| closing_ref_rate_10gb3505001 | Number | Closing Reference Rates 10GB3505001 |
MaturedPrices
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| daily_figure | Date | Daily figures Year | |
| ind_pricing_01gb2512001 | Number | Indicative Pricings 01GB2512001 | |
| ind_pricing_01gb2603001 | Number | Indicative Pricings 01GB2603001 | |
| ind_pricing_01gb2604001 | Number | Indicative Pricings 01GB2604001 | |
| closing_ref_rate_01gb2512001 | Number | Closing Reference Rates 01GB2512001 | |
| closing_ref_rate_05gb3105001 | Number | Closing Reference Rates 05GB3105001 | |
| closing_ref_rate_07gb3306001 | Number | Closing Reference Rates 07GB3306001 |
MaturedYields
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| daily_figure | Date | Daily figures Year | |
| ind_pricing_01gb2512001 | Number | Indicative Pricings 01GB2512001 | |
| ind_pricing_01gb2603001 | Number | Indicative Pricings 01gb2603001 | |
| ind_pricing_01gb2604001 | Number | Indicative Pricings 01gb2604001 | |
| closing_ref_rate_01gb2512001 | Number | Closing Reference Rates 01GB2512001 | |
| closing_ref_rate_01gb2603001 | Number | Closing Reference Rates 01gb2603001 | |
| closing_ref_rate_01gb2604001 | Number | Closing Reference Rates 01gb2604001 |