API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/customer-deposits-by-type-hkd-fcRequest 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 | |
| lb_demand_hkd | Number | HK$ million | Licensed banks Demand HK$ |
| lb_demand_fc | Number | HK$ million | Licensed banks Demand F.C. |
| lb_demand_total | Number | HK$ million | Licensed banks Demand Total |
| lb_savings_hkd | Number | HK$ million | Licensed banks Savings HK$ |
| lb_savings_fc | Number | HK$ million | Licensed banks Savings F.C. |
| lb_savings_total | Number | HK$ million | Licensed banks Savings Total |
| lb_time_hkd | Number | HK$ million | Licensed banks Time HK$ |
| lb_time_fc | Number | HK$ million | Licensed banks Time F.C. |
| lb_time_total | Number | HK$ million | Licensed banks Time Total |
| lb_total_hkd | Number | HK$ million | Licensed banks Total HK$ |
| lb_total_fc | Number | HK$ million | Licensed banks Total F.C. |
| lb_total | Number | HK$ million | Licensed banks Total Total |
| rlb_hkd | Number | HK$ million | Restricted licence banks HK$ |
| rlb_fc | Number | HK$ million | Restricted licence banks F.C. |
| rlb_total | Number | HK$ million | Restricted licence banks Total |
| dtc_hkd | Number | HK$ million | Deposit-taking companies HK$ |
| dtc_fc | Number | HK$ million | Deposit-taking companies F.C. |
| dtc_total | Number | HK$ million | Deposit-taking companies Total |
| rlb_dtc_hkd | Number | HK$ million | Restricted licence banks and deposit-taking companies HK$ |
| rlb_dtc_fc | Number | HK$ million | Restricted licence banks and deposit-taking companies F.C. |
| rlb_dtc_total | Number | HK$ million | Restricted licence banks and deposit-taking companies Total |
| all_ais_hkd | Number | HK$ million | All authorized institutions HK$ |
| all_ais_fc | Number | HK$ million | All authorized institutions F.C. |
| all_ais_total | Number | HK$ million | All authorized institutions Total |
Footnotes:
| 1. There is a break in data series due to the inclusion of short-term Exchange Fund placements of less than one month since April 1997. |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/customer-deposits-by-type-hkd-fc?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/customer-deposits-by-type-hkd-fc?offset=0'with urllib.request.urlopen (url) as req:print (req.read())