API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/elc-pos-v-allRequest 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 | |
| liability_bank_outhk_hkd | Number | HK$ million | Position vis-a-vis all countries/jurisdictions Liabilities to banks outside Hong Kong HK$2 |
| liability_bank_outhk_fc | Number | HK$ million | Position vis-a-vis all countries/jurisdictions Liabilities to banks outside Hong Kong F.C. |
| claim_bank_outhk_hkd | Number | HK$ million | Position vis-a-vis all countries/jurisdictions Claims on banks outside Hong Kong HK$ |
| claim_bank_outhk_fc | Number | HK$ million | Position vis-a-vis all countries/jurisdictions Claims on banks outside Hong Kong F.C. |
| liability_nbc_outhk_hkd | Number | HK$ million | Position vis-a-vis all countries/jurisdictions Liabilities to non-bank customers outside Hong Kong HK$ |
| liability_nbc_outhk_fc | Number | HK$ million | Position vis-a-vis all countries/jurisdictions Liabilities to non-bank customers outside Hong Kong F.C. |
| claim_nbc_outhk_hkd | Number | HK$ million | Position vis-a-vis all countries/jurisdictions Claims on non-bank customers outside Hong Kong HK$ |
| claim_nbc_outhk_fc | Number | HK$ million | Position vis-a-vis all countries/jurisdictions Claims on non-bank customers outside Hong Kong F.C. |
Footnotes:
| 1. For positions from June 2015 onwards, the external liabilities and claims data are collected following the Bank for International Settlements' (BIS) Guidelines for Reporting the BIS International Banking Statistics issued in March 2013 (BIS Guidelines). The data are analysed according to the residence of counterparty. Some positions have been reclassified and are not directly comparable with positions before June 2015. |
| 2. Incomplete data coverage for positions before December 2014 due to reporting gaps of authorized institutions. |
| 3. External liabilities and claims are analysed by the address of the counterparty. This means, in the case a company with branches, the business address of the office with which the liabilities or claims were incurred and in the case of an individual, his/her home address. |
| 4. Note that only quarterly figures are available prior to April 1994 while the monthly series are available since then. |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/elc-pos-v-all?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/elc-pos-v-all?offset=0'with urllib.request.urlopen (url) as req:print (req.read())