API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/customer-deposits-by-currencyRequest 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 | |
| fc_swap_deposits | Number | HK$ million | Foreign currency swap deposits |
| deposits_hkd | Number | HK$ million | Deposits with authorized institutions (Adjusted for foreign currency swap deposits) HK$2 |
| deposits_usd | Number | HK$ million | Deposits with authorized institutions (Adjusted for foreign currency swap deposits) US$3 |
| deposits_nonusd_fc | Number | HK$ million | Deposits with authorized institutions (Adjusted for foreign currency swap deposits) Non-US$ foreign currencies3 |
| deposits_all_fc | Number | HK$ million | Deposits with authorized institutions (Adjusted for foreign currency swap deposits) All foreign currencies3 |
| deposits_all | Number | HK$ million | Deposits with authorized institutions (Adjusted for foreign currency swap deposits) All currencies |
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. |
| 2. Adjusted to include foreign currency swap deposits |
| 3. Adjusted to exclude foreign currency swap deposits |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/customer-deposits-by-currency?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-currency?offset=0'with urllib.request.urlopen (url) as req:print (req.read())