API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/gov-bond/tender-results-gov-bonds-ibip?segment=2yearRequest Parameters (Mandatory)
Parameter Name | Description |
---|---|
segment | Used to indicate which sets of data are going to retrieve. Format: segment=data segment name (2year/3year/5year/10year/15year) Example: segment=2year |
Output Fields (JSON) | Swagger Format |
Name | Type | Unit Of Measure | Description |
---|---|---|---|
issue_number | String | Issue number | |
ni_ro | String | New issue (NI)/Re-open (RO) | |
issue_date | Date | Issue Date Date in ISO format yyyy-mm-dd, For example, 1997-01-01 | |
expected_maturity_date | Date | Expected maturity date Date in ISO format yyyy-mm-dd, For example, 1997-01-01 | |
coupon | Number | % per annum | Coupon |
average_yield_accepted | Number | % | Average yield accepted |
amount_applied | Number | HK$ billion | Amount applied |
amount_allotted | Number | HK$ billion | Amount allotted |
bid-to-cover_ratio | Number | Bid-to-cover ratio |
Footnotes:
Notes (5 Year): In addition, the HKSAR Government issued two Islamic bonds under the Government Bond Programme, each with an issuance size of US$1 billion and a tenor of 5 years on 18 September 2014 and on 3 June 2015. |
Notes (10 Year): In addition, the HKSAR Government issued an Islamic bond under the Government Bond Programme, with an issuance size of US$1 billion and a tenor of 10 years on 28 February 2017. |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/gov-bond/tender-results-gov-bonds-ibip?segment=2year&offset=0',dataType:'json',success:function(data){alert('results found:'+ data.result.datasize)}});
Python Example
import urllib.requesturl = 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/gov-bond/tender-results-gov-bonds-ibip?segment=2year&offset=0'with urllib.request.urlopen (url) as req:print (req.read())