API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/residential-mortgage-surveyRequest 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 | Year and Month in ISO format yyyy-mm, For example, 2019-09 | |
| outstanding_loans_amt | Number | HK$ Mn | As at end of period Outstanding loans Value |
| outstanding_loans_amt_mom | Number | % | As at end of period Outstanding loans Value (M-o-M % change) |
| outstanding_loans_amt_yoy | Number | % | As at end of period Outstanding loans Value (Y-o-Y % change) |
| outstanding_loans_cofin_gf_amt | Number | HK$ Mn | As at end of period Outstanding loans Loans associated with co-financing schemes6 Government-funded schemes: Value |
| outstanding_loans_cofin_gf | Number | No. | As at end of period Outstanding loans Loans associated with co-financing schemes6 Government-funded schemes: Number |
| outstanding_loans_cofin_ps_amt | Number | HK$ Mn | As at end of period Outstanding loans Loans associated with co-financing schemes6 Schemes offered by the private sector: Value |
| outstanding_loans_cofin_ps | Number | No. | As at end of period Outstanding loans Loans associated with co-financing schemes6 Schemes offered by the private sector: Number |
| delinquency_ratio | Number | % | As at end of period Outstanding loans Delinquency ratio4 More than 3 months |
| delinquency_ratio_6mth | Number | % | As at end of period Outstanding loans Delinquency ratio4 More than 6 months |
| resch_loan_ratio | Number | % | As at end of period Outstanding loans Rescheduled loan ratio5 |
| new_loans_app_received | Number | No. | During the period New applications received Number |
| new_loans_app_received_mom | Number | % | During the period New applications received Number (M-o-M% change) |
| new_loans_drawn_amt | Number | HK$ Mn | During the period New loans drawn down Value |
| new_loans_drawn_amt_mom | Number | % | During the period New loans drawn down Value (M-o-M% change) |
| new_loans_drawn | Number | No. | During the period New loans drawn down Number |
| new_loans_drawn_mom | Number | % | During the period New loans drawn down Number (M-o-M% change) |
| new_loans_approved_amt | Number | HK$ Mn | During the period New loans approved3 Value |
| new_loans_approved_amt_mom | Number | % | During the period New loans approved3 Value (M-o-M% change) |
| new_loans_approved | Number | No. | During the period New loans approved3 Number |
| new_loans_approved_mom | Number | % | During the period New loans approved3 Number (M-o-M% change) |
| new_loans_approved_avg_size | Number | HK$ Mn | During the period New loans approved3 Average size |
| new_loans_approved_lv_ratio | Number | % | During the period New loans approved3 Loan-to-value ratio7 |
| new_loans_approved_contra_life | Number | Month | During the period New loans approved3 Contractual life7 |
| new_loans_approved_cofin_amt | Number | HK$ Mn | During the period New loans approved3 Loans associated with co-financing schemes Value |
| new_loans_approved_cofin | Number | No. | During the period New loans approved3 Loans associated with co-financing schemes Number |
| new_loans_approved_pt_amt_pri | Number | HK$ Mn | During the period New loans approved3 Type of property transaction Value Primary market |
| new_loans_approved_pt_amt_sec | Number | HK$ Mn | During the period New loans approved3 Type of property transaction Value Secondary market |
| new_loans_approved_pt_amt_refin | Number | HK$ Mn | During the period New loans approved3 Type of property transaction Value Refinancing |
| new_loans_approved_pt_primkt | Number | No. | During the period New loans approved3 Type of property transaction Number Primary market |
| new_loans_approved_pt_secmkt | Number | No. | During the period New loans approved3 Type of property transaction Number Secondary market |
| new_loans_approved_pt_refin | Number | No. | During the period New loans approved3 Type of property transaction Number Refinancing |
| new_loans_approved_undrawn_amt | Number | HK$ Mn | During the period New loans approved3 New loans approved but not yet drawn Value |
| new_loans_approved_undrawn | Number | No. | During the period New loans approved3 New loans approved but not yet drawn Number |
| ir_new_loans_approved_hibor | Number | % | During the period Interest rates on new loans approved With reference to Hong Kong Interbank Offered Rate (HIBOR) |
| ir_new_loans_approved_blr | Number | % | During the period Interest rates on new loans approved With reference to Best Lending Rate (BLR) |
| ir_new_loans_approved_fixed | Number | % | During the period Interest rates on new loans approved Fixed rate |
| ir_new_loans_approved_other | Number | % | During the period Interest rates on new loans approved Others |
| loan_wo_amt | Number | HK$ Mn | During the period Loans written off8 Value of loans written off |
| loan_wo_12mth_amt | Number | HK$ Mn | Over the past 12 months Loans written off8 Loans written off over the past 12 months Value |
| loan_wo_12mth_pa_outstand_loans | String | % | Over the past 12 months Loans written off8 Over the past 12 months As % of the average outstanding loans9 |
Footnotes:
| 1. Residential mortgage loans (RMLs) of the authorized institutions covered in this survey represent about 99% of the banking sector. |
| 2. RMLs in this survey are loans (including refinancing loans) to private individuals for the purchase of residential properties, including uncompleted units, but other than those properties under the Home Ownership Scheme, the Private Sector Participation Scheme and the Tenants Purchase Scheme. |
| 3. New loans approved are mortgage loans approved during the surveyed month. The loans can either be drawn down in the same month or in the followingmonths. Loans that are approved but not yet drawn, which have implications for the amount of gross new loans made in the following months, are shown under the item "New loans approved during the month but not yet drawn". |
| 4. Delinquency ratio is measured by a ratio of total amount of overdue loans to total outstanding loans. |
| 5. Rescheduled loan ratio is measured by a ratio of total amount of rescheduled loans to total outstanding loans. |
| 6. Co-financing schemes refer to those schemes that involve the provision of topup finance by property developer(s) or other co-financier(s) in addition to mortgage loans advanced by authorized institutions. For loans associated with co-financing schemes, only the portion of loans advanced by reporting institutions is included in this survey. |
| 7. Average loan-to-value ratio and average contractual life for new loans approved during the surveyed month are average figures weighted by the amount of new loans approved during the surveyed month by individual reporting institutions. |
| 8. Loans written off over the past 12 months as a percentage of the average outstanding loans is calculated as: total value of loans written off during the past 12-month period as a percentage of the average outstanding loan value over the 12-month period [i.e. (opening + closing) ÷ 2]. |
| 9. If the % is less than 0.05%, value display as '*'. |
Footnotes (Old):
| 10. Residential mortgage loans in this survey are loans (including refinancing loans) to private individuals for the purchase of residential properties, including uncompleted units, but other than those properties under the Home Ownership Scheme, Private Sector Participation Scheme and Tenants Purchase Scheme. Mortgage loans to corporate clients are excluded from the survey. The authorized institutions participating in this survey accounted for over 95% of the total residential mortgage lending business. |
| 11. There is a break in data series at December 2000 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-survey?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-survey?offset=0'with urllib.request.urlopen (url) as req:print (req.read())