API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/bank-svf-info/bank-complaint-progressRequest Parameters (Mandatory)
| Parameter Name | Description |
|---|---|
| segment | Used to indicate which sets of data are going to retrieve. Format: segment=(new|old) Example: segment=new |
New*
| Output Fields (JSON) | Swagger Format |
| Name | Type | Unit Of Measure | Description |
|---|---|---|---|
| end_of_half_year | Date | Year and half-year format For example, 2022-H1 | |
| conduct_related_r | Number | Amount | Conduct-related issues Received in current half-year period |
| conduct_related_c | Number | Amount | Conduct-related issues Completed in current half-year period |
| general_bank_r | Number | Amount | General banking services1 Received in current half-year period |
| general_bank_c | Number | Amount | General banking services1 Completed in current half-year period |
| total_cur_r | Number | Amount | Total Received in current half-year period |
| total_cur_c | Number | Amount | Total Completed in current half-year period |
Old*
| 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, 2021-02 | |
| conduct_related_last_mth_p | Number | Amount | Conduct-related issues In progress as at previous month |
| conduct_related_cur_mth_r | Number | Amount | Conduct-related issues Received in current month |
| conduct_related_cur_mth_c | Number | Amount | Conduct-related issues Completed in current month |
| conduct_related_cur_mth_p | Number | Amount | Conduct-related issues In progress as at current month |
| general_bank_last_mth_p | Number | Amount | General banking services1 In progress as at previous month |
| general_bank_cur_mth_r | Number | Amount | General banking services1 Received in current month |
| general_bank_cur_mth_c | Number | Amount | General banking services1 Completed in current month |
| general_bank_cur_mth_p | Number | Amount | General banking services1 In progress as at current month |
| total_last_mth_p | Number | Amount | Total In progress as at previous month |
| total_cur_mth_r | Number | Amount | Total Received in current month |
| total_cur_mth_c | Number | Amount | Total Completed in current month |
| total_cur_mth_p | Number | Amount | Total In progress as at current month |
Footnotes:
| 1. These are complaints concerning service quality and commercial disputes. |
| *. The tables "New" and "Old" refer to data in new format (half-yearly) and previous format (monthly) respectively. Table "Old" is replaced by table "New" and will not be updated in the future. |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/bank-svf-info/bank-complaint-progress?offset=0',dataType:'json',success:function(data){alert('results found:'+ data.result.datasize)}});
Python Example
import urllib.requesturl = 'https://api.hkma.gov.hk/public/bank-svf-info/bank-complaint-progress?offset=0'with urllib.request.urlopen (url) as req:print (req.read())