API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/residential-mortgage-loans-neg-equity
| |
Output Fields (JSON) | Swagger Format |
Name | Type | Unit Of Measure | Description |
---|---|---|---|
end_of_quarter | Date | Year and Quater in ISO format yyyy-qq, For example, 1997-Q1 | |
outstanding_loans | Number | No. | Total outstanding number |
outstanding_loans_ratio | String | % | Total outstanding number As % of total mortgage borrowers1 |
outstanding_loans_amt | Number | HK$ million | Total outstanding value |
outstanding_loans_amt_ratio | String | % | Total outstanding value As % of total outstanding value1 |
unsecured_portion_amt | Number | HK$ million | Value of unsecured portion |
lv_ratio | Number | % | Loan-to-value ratio |
Footnotes:
1. Average during period (calculated as [opening stock + closing stock]/2) |
2. There is a break in data series at Q4 2001 due to an increase in the number of surveyed institutions. |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/residential-mortgage-loans-neg-equity?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/banking/residential-mortgage-loans-neg-equity?offset=0'with urllib.request.urlopen (url) as req:print (req.read())