API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/er-ir/composite-irRequest Parameters (Mandatory)
| Parameter Name | Description |
|---|---|
| segment | Used to indicate which sets of data are going to retrieve. Format: segment=data segment name (new/old) Example: segment=new |
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| end_of_month | Date | As at end of Year and Month in ISO format yyyy-mm, For example, 1997-01 | |
| interest_rate | Number | percent per annum | interest rate |
Footnotes:
| 1. The composite interest rate is a weighted average interest rate of all Hong Kong dollar interest-rate-sensitive liabilities, which include deposits from customers, amounts due to banks, negotiable certificates of deposit and other debt instruments, and all other liabilities that do not involve any formal payment of interest but the values of which are sensitive to interest rate movements (such as Hong Kong dollar non-interest bearing demand deposits) on the books of banks. The methodoloy of the compilation of the composite interest rate can be found in HKMA Research Memorandum, http://www.hkma.gov.hk/media/eng/publication-and-research/research/working-papers/pre2007/RM26-2005.pdf |
| 2. Since June 2019, the composite interest rate has been calculated based on the new local “Interest rate risk in the banking book” (IRRBB) framework. As such, the figures are not strictly comparable with those of previous months. |
Footnotes (Old):
| 1. The composite interest rate is a weighted average interest rate of all Hong Kong dollar interest bearing liabilities, which include deposits from customers, amounts due to banks, negotiable certificates of deposit and other debt instruments, and Hong Kong dollar non-interest bearing demand deposits on the books of banks. The methodology of the compilation of the composite interest rate can be found in HKMA Research Memorandum, http://www.hkma.gov.hk/media/eng/publication-and-research/research/working-papers/pre2007/RM26-2005.pdf. |
Disclaimer:
| The composite interest rate is complied by information obtained from a number of retail banks. Although great care has been taken to ensure that the information provided in this table is accurate and up to date as at the date of publication, there is a possibility that the retail banks may subsequently make amendments or revisions to their reported statistics after submitting the relevant returns to the HKMA. In these circumstances, the HKMA will not make a corresponding amendment to the composite interest rate. The HKMA does not warrant that all or any part of the information provided in this table is fit for any particular purpose, up to date, accurate or complete. Such information is for reference only and is subject to changes without notice. The HKMA shall not be liable for any loss or damage suffered as a result of any use or reliance on any of the information provided herein and under no circumstances shall be liable for any failure of the website, including without limitation, delay in operation or unavailability of access to this website. By using or accessing any part of this website, you agree to the terms and conditions governing the use of this website, including but not limited to this disclaimer. |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/er-ir/composite-ir?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/er-ir/composite-ir?offset=0'with urllib.request.urlopen (url) as req:print (req.read())