API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/balance-sheet-aisRequest 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 | |
| liab_amtaisinhk_hkd | Number | HK$ million | Liabilities Amount due to authorized institutions in Hong Kong HK$ |
| liab_amtaisinhk_fc | Number | HK$ million | Liabilities Amount due to authorized institutions in Hong Kong F.C. |
| liab_amtaisinhk_total | Number | HK$ million | Liabilities Amount due to authorized institutions in Hong Kong Total |
| liab_amtbanksabroad_hkd | Number | HK$ million | Liabilities Amount due to banks abroad HK$ |
| liab_amtbanksabroad_fc | Number | HK$ million | Liabilities Amount due to banks abroad F.C. |
| liab_amtbanksabroad_total | Number | HK$ million | Liabilities Amount due to banks abroad Total |
| liab_depcust_hkd | Number | HK$ million | Liabilities Deposits from customers HK$ |
| liab_depcust_fc | Number | HK$ million | Liabilities Deposits from customers F.C. |
| liab_depcust_total | Number | HK$ million | Liabilities Deposits from customers Total |
| liab_ncdepoutst_hkd | Number | HK$ million | Liabilities Negotiable certificates of deposit outstanding HK$ |
| liab_ncdepoutst_fc | Number | HK$ million | Liabilities Negotiable certificates of deposit outstanding F.C. |
| liab_ncdepoutst_total | Number | HK$ million | Liabilities Negotiable certificates of deposit outstanding Total |
| liab_othdebtinstoutst_hkd | Number | HK$ million | Liabilities Other debt instruments outstanding HK$ |
| liab_othdebtinstoutst_fc | Number | HK$ million | Liabilities Other debt instruments outstanding F.C. |
| liab_othdebtinstoutst_total | Number | HK$ million | Liabilities Other debt instruments outstanding Total |
| liab_capreserv_hkd | Number | HK$ million | Liabilities Capital, reserves and other liabilities HK$ |
| liab_capreserv_fc | Number | HK$ million | Liabilities Capital, reserves and other liabilities F.C. |
| liab_capreserv_total | Number | HK$ million | Liabilities Capital, reserves and other liabilities Total |
| liab_total_hkd | Number | HK$ million | Total liabilities HK$ |
| liab_total_fc | Number | HK$ million | Total liabilities F.C. |
| liab_total | Number | HK$ million | Total liabilities Total |
| asst_notescoins_hkd | Number | HK$ million | Assets Notes and coins HK$ |
| asst_notescoins_fc | Number | HK$ million | Assets Notes and coins F.C. |
| asst_notescoins_total | Number | HK$ million | Assets Notes and coins Total |
| asst_amtaisinhk_hkd | Number | HK$ million | Assets Amount due from authorized institutions in Hong Kong HK$ |
| asst_amtaisinhk_fc | Number | HK$ million | Assets Amount due from authorized institutions in Hong Kong F.C. |
| asst_amtaisinhk_total | Number | HK$ million | Assets Amount due from authorized institutions in Hong Kong Total |
| asst_amtbanksabroad_hkd | Number | HK$ million | Assets Amount due from banks abroad HK$ |
| asst_amtbanksabroad_fc | Number | HK$ million | Assets Amount due from banks abroad F.C. |
| asst_amtbanksabroad_total | Number | HK$ million | Assets Amount due from banks abroad Total |
| asst_loanadvtocust_hkd | Number | HK$ million | Assets Loans and advances to customers HK$ |
| asst_loanadvtocust_fc | Number | HK$ million | Assets Loans and advances to customers F.C. |
| asst_loanadvtocust_total | Number | HK$ million | Assets Loans and advances to customers Total |
| asst_ncdepheld_hkd | Number | HK$ million | Assets Negotiable certificates of deposit held HK$ |
| asst_ncdepheld_fc | Number | HK$ million | Assets Negotiable certificates of deposit held F.C. |
| asst_ncdepheld_total | Number | HK$ million | Assets Negotiable certificates of deposit held Total |
| asst_ncdepheld_lb_hkd | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by licensed banks in Hong Kong HK$ |
| asst_ncdepheld_lb_fc | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by licensed banks in Hong Kong F.C. |
| asst_ncdepheld_lb_total | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by licensed banks in Hong Kong Total |
| asst_ncdepheld_rlb_hkd | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by restricted licence banks HK$ |
| asst_ncdepheld_rlb_fc | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by restricted licence banks F.C. |
| asst_ncdepheld_rlb_total | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by restricted licence banks Total |
| asst_ncdepheld_dtc_hkd | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by deposit-taking companies HK$ |
| asst_ncdepheld_dtc_fc | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by deposit-taking companies F.C. |
| asst_ncdepheld_dtc_total | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by deposit-taking companies Total |
| asst_ncdepheld_bkouthk_hkd | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by banks outside Hong Kong HK$ |
| asst_ncdepheld_bkouthk_fc | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by banks outside Hong Kong F.C. |
| asst_ncdepheld_bkouthk_total | Number | HK$ million | Assets Negotiable certificates of deposit held: Issued by banks outside Hong Kong Total |
| asst_negodebt_hkd | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: HK$ |
| asst_negodebt_fc | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: F.C. |
| asst_negodebt_total | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Total |
| asst_negodebt_accbill_hkd | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Acceptances and bills of exchange HK$ |
| asst_negodebt_accbill_fc | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Acceptances and bills of exchange F.C. |
| asst_negodebt_accbill_total | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Acceptances and bills of exchange Total |
| asst_negodebt_fltnote_hkd | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Floating rate notes and commercial papers HK$ |
| asst_negodebt_fltnote_fc | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Floating rate notes and commercial papers F.C. |
| asst_negodebt_fltnote_total | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Floating rate notes and commercial papers Total |
| asst_negodebt_gov_hkd | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Government bills, notes and bonds HK$ |
| asst_negodebt_gov_fc | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Government bills, notes and bonds F.C. |
| asst_negodebt_gov_total | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Government bills, notes and bonds Total |
| asst_negodebt_other_hkd | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Other debt instruments HK$ |
| asst_negodebt_other_fc | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Other debt instruments F.C. |
| asst_negodebt_other_total | Number | HK$ million | Assets Negotiable debt instruments held, other than NCDs: Other debt instruments Total |
| asst_invinshare_hkd | Number | HK$ million | Assets Investments in shareholdings HK$ |
| asst_invinshare_fc | Number | HK$ million | Assets Investments in shareholdings F.C. |
| asst_invinshare_total | Number | HK$ million | Assets Investments in shareholdings Total |
| asst_intinland_hkd | Number | HK$ million | Assets Interests in land and buildings HK$ |
| asst_intinland_fc | Number | HK$ million | Assets Interests in land and buildings F.C. |
| asst_intinland_total | Number | HK$ million | Assets Interests in land and buildings Total |
| asst_other_hkd | Number | HK$ million | Assets Other assets HK$ |
| asst_other_fc | Number | HK$ million | Assets Other assets F.C. |
| asst_other_total | Number | HK$ million | Assets Other assets Total |
| total_asst_hkd | Number | HK$ million | Total assets HK$ |
| total_asst_fc | Number | HK$ million | Total assets F.C. |
| total_asst_total | Number | HK$ million | Total assets Total |
| no_of_report_instit | Number | Quantity | Number of reporting institutions |
| no_of_local_branch | Number | Quantity | Number of local branches |
Footnotes:
| 1. The balance sheet of authorized institutions excludes certificates of indebtedness issued by the Exchange Fund, and the counterpart bank notes issued. Loans and advances refer to the position before provision for bad debts. |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/balance-sheet-ais?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/balance-sheet-ais?offset=0'with urllib.request.urlopen (url) as req:print (req.read())