Prices and yields of Government Bonds issued under the Institutional Bond Issuance Programme – Period average figures

API Detailed Documentation

API URL:

https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/gov-bond/instit-bond-price-yield-periodaverage?segment=Benchmark

API Data Enquiry

Request Parameters (Mandatory)

Parameter Name	Description
segment	Used to indicate which sets of data are going to retrieve. Format: segment=data segment name (Benchmark/OutstandPrices/OutstandYields/MaturedPrices/MaturedYields) Example: segment=Benchmark

Benchmark

Output Fields (JSON)

Swagger Format

Name	Type	Unit Of Measure	Description
end_of_month	Date		End of period figures Year and Month in ISO format yyyy-mm, For example, 1997-01
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_10y	Number	percent per annum	Benchmark yields Indicative Pricings 10-year
ind_pricing_15y	Number	percent per annum	Benchmark yields Indicative Pricings 15-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_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

OutstandPrices

Output Fields (JSON)

Swagger Format

Name	Type	Description
end_of_month	Date	End of period figures Year and Month in ISO format yyyy-mm, For example, 1997-01
ind_pricing_10gb2108	Number	Indicative Pricings 10GB2108
ind_pricing_05gb2205	Number	Indicative Pricings 05GB2205
ind_pricing_10gb2301	Number	Indicative Pricings 10GB2301
ind_pricing_03gb2310	Number	Indicative Pricings 03GB2310
ind_pricing_10gb2408	Number	Indicative Pricings 10GB2408
ind_pricing_10gb2601	Number	Indicative Pricings 10GB2601
ind_pricing_10gb2706	Number	Indicative Pricings 10GB2706
ind_pricing_10gb2901	Number	Indicative Pricings 10GB2901
ind_pricing_15gb3007	Number	Indicative Pricings 15GB3007
ind_pricing_15gb3203	Number	Indicative Pricings 15GB3203
ind_pricing_15gb3403	Number	Indicative Pricings 15GB3403
ind_pricing_15gb3603	Number	Indicative Pricings 15GB3603
closing_ref_rate_10gb2108	Number	Closing Reference Rates 10GB2108
closing_ref_rate_05gb2205	Number	Closing Reference Rates 05GB2205
closing_ref_rate_10gb2301	Number	Closing Reference Rates 10GB2301
closing_ref_rate_03gb2310	Number	Closing Reference Rates 03GB2310
closing_ref_rate_10gb2408	Number	Closing Reference Rates 10GB2408
closing_ref_rate_10gb2601	Number	Closing Reference Rates 10GB2601
closing_ref_rate_10gb2706	Number	Closing Reference Rates 10GB2706
closing_ref_rate_10gb2901	Number	Closing Reference Rates 10GB2901
closing_ref_rate_15gb3007	Number	Closing Reference Rates 15GB3007
closing_ref_rate_15gb3203	Number	Closing Reference Rates 15GB3203
closing_ref_rate_15gb3403	Number	Closing Reference Rates 15GB3403
closing_ref_rate_15gb3603	Number	Closing Reference Rates 15GB3603

OutstandYields

Output Fields (JSON)

Swagger Format

Name	Type	Unit Of Measure	Description
end_of_month	Date		End of period figures Year and Month in ISO format yyyy-mm, For example, 1997-01
ind_pricing_10gb2108	Number	percent per annum	Indicative Pricings 10GB2108
ind_pricing_05gb2205	Number	percent per annum	Indicative Pricings 05GB2205
ind_pricing_10gb2301	Number	percent per annum	Indicative Pricings 10GB2301
ind_pricing_03gb2310	Number	percent per annum	Indicative Pricings 03GB2310
ind_pricing_10gb2408	Number	percent per annum	Indicative Pricings 10GB2408
ind_pricing_10gb2601	Number	percent per annum	Indicative Pricings 10GB2601
ind_pricing_10gb2706	Number	percent per annum	Indicative Pricings 10GB2706
ind_pricing_10gb2901	Number	percent per annum	Indicative Pricings 10GB2901
ind_pricing_15gb3007	Number	percent per annum	Indicative Pricings 15GB3007
ind_pricing_15gb3203	Number	percent per annum	Indicative Pricings 15GB3203
ind_pricing_15gb3403	Number	percent per annum	Indicative Pricings 15GB3403
ind_pricing_15gb3603	Number	percent per annum	Indicative Pricings 15GB3603
closing_ref_rate_10gb2108	Number	percent per annum	Closing Reference Rates 10GB2108
closing_ref_rate_05gb2205	Number	percent per annum	Closing Reference Rates 05GB2205
closing_ref_rate_10gb2301	Number	percent per annum	Closing Reference Rates 10GB2301
closing_ref_rate_03gb2310	Number	percent per annum	Closing Reference Rates 03GB2310
closing_ref_rate_10gb2408	Number	percent per annum	Closing Reference Rates 10GB2408
closing_ref_rate_10gb2601	Number	percent per annum	Closing Reference Rates 10GB2601
closing_ref_rate_10gb2706	Number	percent per annum	Closing Reference Rates 10GB2706
closing_ref_rate_10gb2901	Number	percent per annum	Closing Reference Rates 10GB2901
closing_ref_rate_15gb3007	Number	percent per annum	Closing Reference Rates 15GB3007
closing_ref_rate_15gb3203	Number	percent per annum	Closing Reference Rates 15GB3203
closing_ref_rate_15gb3403	Number	percent per annum	Closing Reference Rates 15GB3403
closing_ref_rate_15gb3603	Number	percent per annum	Closing Reference Rates 15GB3603

MaturedPrices

Output Fields (JSON)

Swagger Format

Name	Type	Description
end_of_month	Date	End of period figures Year and Month in ISO format yyyy-mm, For example, 1997-01
ind_pricing_02gb1109	Number	Indicative Pricings 02GB1109
ind_pricing_02gb1203	Number	Indicative Pricings 02GB1203
ind_pricing_02gb1209	Number	Indicative Pricings 02GB1209
ind_pricing_02gb1303	Number	Indicative Pricings 02GB1303
ind_pricing_02gb1309	Number	Indicative Pricings 02GB1309
ind_pricing_02gb1403	Number	Indicative Pricings 02GB1403
ind_pricing_05gb1411	Number	Indicative Pricings 05GB1411
ind_pricing_03gb1505	Number	Indicative Pricings 03GB1505
ind_pricing_05gb1512	Number	Indicative Pricings 05GB1512
ind_pricing_03gb1605	Number	Indicative Pricings 03GB1605
ind_pricing_05gb1612	Number	Indicative Pricings 05GB1612
ind_pricing_03gb1704	Number	Indicative Pricings 03GB1704
ind_pricing_03gb1711	Number	Indicative Pricings 03GB1711
ind_pricing_05gb1802	Number	Indicative Pricings 05GB1802
ind_pricing_05gb1902	Number	Indicative Pricings 05GB1902
ind_pricing_10gb2001	Number	Indicative Pricings 10GB2001
ind_pricing_05gb2002	Number	Indicative Pricings 05GB2002
ind_pricing_05gb2011	Number	Indicative Pricings 05GB2011
closing_ref_rate_02gb1109	Number	Closing Reference Rates 02GB1109
closing_ref_rate_02gb1203	Number	Closing Reference Rates 02GB1203
closing_ref_rate_02gb1209	Number	Closing Reference Rates 02GB1209
closing_ref_rate_02gb1303	Number	Closing Reference Rates 02GB1303
closing_ref_rate_02gb1309	Number	Closing Reference Rates 02GB1309
closing_ref_rate_02gb1403	Number	Closing Reference Rates 02GB1403
closing_ref_rate_05gb1411	Number	Closing Reference Rates 05GB1411
closing_ref_rate_03gb1505	Number	Closing Reference Rates 03GB1505
closing_ref_rate_05gb1512	Number	Closing Reference Rates 05GB1512
closing_ref_rate_03gb1605	Number	Closing Reference Rates 03GB1605
closing_ref_rate_05gb1612	Number	Closing Reference Rates 05GB1612
closing_ref_rate_03gb1704	Number	Closing Reference Rates 03GB1704
closing_ref_rate_03gb1711	Number	Closing Reference Rates 03GB1711
closing_ref_rate_05gb1802	Number	Closing Reference Rates 05GB1802
closing_ref_rate_05gb1902	Number	Closing Reference Rates 05GB1902
closing_ref_rate_10gb2001	Number	Closing Reference Rates 10GB2001
closing_ref_rate_05gb2002	Number	Closing Reference Rates 05GB2002
closing_ref_rate_05gb2011	Number	Closing Reference Rates 05GB2011

MaturedYields

Output Fields (JSON)

Swagger Format

Name	Type	Unit Of Measure	Description
end_of_month	Date		End of period figures Year and Month in ISO format yyyy-mm, For example, 1997-01
ind_pricing_02gb1109	Number	percent per annum	Indicative Pricings 02GB1109
ind_pricing_02gb1203	Number	percent per annum	Indicative Pricings 02GB1203
ind_pricing_02gb1209	Number	percent per annum	Indicative Pricings 02GB1209
ind_pricing_02gb1303	Number	percent per annum	Indicative Pricings 02GB1303
ind_pricing_02gb1309	Number	percent per annum	Indicative Pricings 02GB1309
ind_pricing_02gb1403	Number	percent per annum	Indicative Pricings 02GB1403
ind_pricing_05gb1411	Number	percent per annum	Indicative Pricings 05GB1411
ind_pricing_03gb1505	Number	percent per annum	Indicative Pricings 03GB1505
ind_pricing_05gb1512	Number	percent per annum	Indicative Pricings 05GB1512
ind_pricing_03gb1605	Number	percent per annum	Indicative Pricings 03GB1605
ind_pricing_05gb1612	Number	percent per annum	Indicative Pricings 05GB1612
ind_pricing_03gb1704	Number	percent per annum	Indicative Pricings 03GB1704
ind_pricing_03gb1711	Number	percent per annum	Indicative Pricings 03GB1711
ind_pricing_05gb1802	Number	percent per annum	Indicative Pricings 05GB1802
ind_pricing_05gb1902	Number	percent per annum	Indicative Pricings 05GB1902
ind_pricing_10gb2001	Number	percent per annum	Indicative Pricings 10GB2001
ind_pricing_05gb2002	Number	percent per annum	Indicative Pricings 05GB2002
ind_pricing_05gb2011	Number	percent per annum	Indicative Pricings 05GB2011
closing_ref_rate_02gb1109	Number	percent per annum	Closing Reference Rates 02GB1109
closing_ref_rate_02gb1203	Number	percent per annum	Closing Reference Rates 02GB1203
closing_ref_rate_02gb1209	Number	percent per annum	Closing Reference Rates 02GB1209
closing_ref_rate_02gb1303	Number	percent per annum	Closing Reference Rates 02GB1303
closing_ref_rate_02gb1309	Number	percent per annum	Closing Reference Rates 02GB1309
closing_ref_rate_02gb1403	Number	percent per annum	Closing Reference Rates 02GB1403
closing_ref_rate_05gb1411	Number	percent per annum	Closing Reference Rates 05GB1411
closing_ref_rate_03gb1505	Number	percent per annum	Closing Reference Rates 03GB1505
closing_ref_rate_05gb1512	Number	percent per annum	Closing Reference Rates 05GB1512
closing_ref_rate_03gb1605	Number	percent per annum	Closing Reference Rates 03GB1605
closing_ref_rate_05gb1612	Number	percent per annum	Closing Reference Rates 05GB1612
closing_ref_rate_03gb1704	Number	percent per annum	Closing Reference Rates 03GB1704
closing_ref_rate_03gb1711	Number	percent per annum	Closing Reference Rates 03GB1711
closing_ref_rate_05gb1802	Number	percent per annum	Closing Reference Rates 05GB1802
closing_ref_rate_05gb1902	Number	percent per annum	Closing Reference Rates 05GB1902
closing_ref_rate_10gb2001	Number	percent per annum	Closing Reference Rates 10GB2001
closing_ref_rate_05gb2002	Number	percent per annum	Closing Reference Rates 05GB2002
closing_ref_rate_05gb2011	Number	percent per annum	Closing Reference Rates 05GB2011

Footnotes:

1. Figures powered by Thomson Reuters.

2. Calculation method and further information are set out in the Reference Manual for Government Bond Indicative Pricings
(http://www.hkgb.gov.hk/en/others/documents/IndicativePricings_Manual.pdf).

API Examples

Javascript Example

$.ajax({
url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/gov-bond/instit-bond-price-yield-periodaverage?segment=Benchmark&offset=0',
dataType:'json',
success:function(data){
alert('results found:'+ data.result.datasize)
}
});

Python Example

import urllib.request
url = 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/gov-bond/instit-bond-price-yield-periodaverage?segment=Benchmark&offset=0'
with urllib.request.urlopen (url) as req:
print (req.read())

How to use the APIs

To learn more, please visit API documentation.