API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/ibpgsbp/instit-bond-price-yield-periodaverage-ibpgsbp-hkdRequest Parameters (Mandatory)
| Parameter Name | Description |
|---|---|
| segment | Specifies which period-average dataset segment to retrieve. Supported values are Benchmark Format: string Example: Benchmark |
Benchmark
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| period_average | Date | Period average figures Year and Month in ISO format yyyy-mm | |
| 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 | Benchmark yields Indicative Pricings 7-year |
| ind_pricing_10y | Number | percent per annum | Benchmark yields Indicative Pricings 10-year |
| ind_pricing_15y | Number | percent per annum | Benchmark yields Indicative Pricings 15-year |
| ind_pricing_20y | Number | percent per annum | Benchmark yields Indicative Pricings 20-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 |
| closing_ref_rate_15y | Number | percent per annum | Benchmark yields Closing Reference Rates 15-year |
| closing_ref_rate_20y | Number | percent per annum | Benchmark yields Closing Reference Rates 20-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 |
|---|---|---|---|
| period_average | Date | Period average figures Year and Month in ISO format yyyy-mm | |
| ind_pricing_01gh2602001* | Number | Indicative Pricings 01GH2602001* | |
| ind_pricing_01gh2605001* | Number | Indicative Pricings 01GH2605001* | |
| ind_pricing_01gh2608001* | Number | Indicative Pricings 01GH2608001* | |
| ind_pricing_01gh2611001* | Number | Indicative Pricings 01GH2611001* | |
| ind_pricing_03gb2710001 | Number | Indicative Pricings 03GB2710001 | |
| ind_pricing_03gb2804001 | Number | Indicative Pricings 03GB2804001 | |
| ind_pricing_05gb2912001 | Number | Indicative Pricings 05GB2912001 | |
| ind_pricing_05gb3005002 | Number | Indicative Pricings 05GB3005002 | |
| ind_pricing_10gb3501001 | Number | Indicative Pricings 10GB3501001 | |
| ind_pricing_10gb3507001 | Number | Indicative Pricings 10GB3507001 | |
| ind_pricing_15gb3912001 | Number | Indicative Pricings 15GB3912001 | |
| ind_pricing_20gb4503001 | Number | Indicative Pricings 20GB4503001 | |
| closing_ref_rate_03gb2710001 | Number | Closing Reference Rates 03GB2710001 | |
| closing_ref_rate_03gb2804001 | Number | Closing Reference Rates 03GB2804001 | |
| closing_ref_rate_05gb2912001 | Number | Closing Reference Rates 05GB2912001 | |
| closing_ref_rate_05gb3005002 | Number | Closing Reference Rates 05GB3005002 | |
| closing_ref_rate_10gb3501001 | Number | Closing Reference Rates 10GB3501001 | |
| closing_ref_rate_10gb3507001 | Number | Closing Reference Rates 10GB3507001 | |
| closing_ref_rate_15gb3912001 | Number | Closing Reference Rates 15GB3912001 | |
| closing_ref_rate_20gb4503001 | Number | Closing Reference Rates 20GB4503001 |
OutstandYields
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| period_average | Date | Period average figures Year and Month in ISO format yyyy-mm | |
| ind_pricing_03gb2710001 | Number | percent per annum | Indicative Pricings 03GB2710001 |
| ind_pricing_03gb2804001 | Number | percent per annum | Indicative Pricings 03GB2804001 |
| ind_pricing_05gb2912001 | Number | percent per annum | Indicative Pricings 05GB2912001 |
| ind_pricing_05gb3005002 | Number | percent per annum | Indicative Pricings 05GB3005002 |
| ind_pricing_10gb3501001 | Number | percent per annum | Indicative Pricings 10GB3501001 |
| ind_pricing_10gb3507001 | Number | percent per annum | Indicative Pricings 10GB3507001 |
| ind_pricing_15gb3912001 | Number | percent per annum | Indicative Pricings 15GB3912001 |
| ind_pricing_20gb4503001 | Number | percent per annum | Indicative Pricings 20GB4503001 |
| closing_ref_rate_03gb2710001 | Number | percent per annum | Closing Reference Rates 03GB2710001 |
| closing_ref_rate_03gb2804001 | Number | percent per annum | Closing Reference Rates 03GB2804001 |
| closing_ref_rate_05gb2912001 | Number | percent per annum | Closing Reference Rates 05GB2912001 |
| closing_ref_rate_05gb3005002 | Number | percent per annum | Closing Reference Rates 05GB3005002 |
| closing_ref_rate_10gb3501001 | Number | percent per annum | Closing Reference Rates 10GB3501001 |
| closing_ref_rate_10gb3507001 | Number | percent per annum | Closing Reference Rates 10GB3507001 |
| closing_ref_rate_15gb3912001 | Number | percent per annum | Closing Reference Rates 15GB3912001 |
| closing_ref_rate_20gb4503001 | Number | percent per annum | Closing Reference Rates 20GB4503001 |
MaturedPrices
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| period_average | Date | Period average figures Year and Month in ISO format yyyy-mm | |
| ind_pricing_01gh2511001* | Number | Indicative Pricings 01GH2511001* | |
| closing_ref_rate_01gh2511001* | Number | Closing Reference Rates 01GH2511001* |