API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/daily-monetary-statistics/efbn-indicative-price?segment=IndicativePriceRequest Parameters (Mandatory)
| Parameter Name | Description |
|---|---|
| segment | Used to indicate which sets of data are going to retrieve. Format: segment=data segment name (IndicativePrice/Bills/Notes) Example: segment=IndicativePrice |
IndicativePrice
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| end_of_date | Date | Daily figure Date in ISO format yyyy-mm-dd, For example, 1997-01-01 |
|
| term | Text | Term1 | |
| issue_no | Text | Issue Number | |
| yield | Number | % | Yield3 |
| price | Number | HK$ | Price3 |
Bills
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| end_of_date | Date | Daily figure Date in ISO format yyyy-mm-dd, For example, 1997-01-01 |
|
| issue_no | Text | Issue Number | |
| maturity | Date | Maturity Date in ISO format yyyy-mm-dd, For example, 1997-01-01 |
|
| yield | Number | % | Yield3 |
Notes
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| end_of_date | Date | Daily figure Date in ISO format yyyy-mm-dd, For example, 1997-01-01 |
|
| issue_no | Text | Issue Number | |
| maturity | Date | Maturity Date in ISO format yyyy-mm-dd, For example, 1997-01-01 |
|
| coupon | Number | % | Coupon |
| yield | Number | % | Yield3 |
| price | Number | HK$ | Price3 |
Footnotes:
| 1. W – Week, M – Month, YR – Year |
| 2. Starting from 2015, the HKMA has ceased new issuance of exchange fund notes of tenor of 3 years and above. For information on yields for tenor of 3 years and above, please make reference to Hong Kong Government Bonds which are available at http://www.hkgb.gov.hk/en/statistics/indicativepricings.html |
| 3. Data powered by Thomson Reuters. |
| 4. Open API provides data of the latest business day only. |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/daily-monetary-statistics/efbn-indicative-price?segment=IndicativePrice&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/daily-monetary-statistics/efbn-indicative-price?segment=IndicativePrice&offset=0'with urllib.request.urlopen (url) as req:print (req.read())