香港金融管理局现提供以下应用程式介面：
使用香港金融管理局应用程式介面
规范：
https://api.hkma.gov.hk/public/api_uri?parameters…api_url 请参考各类别的应用程式介面规格。
至于可选的参数，请参考以下的「参数（可选）」
参数（可选）
| 参数名称 | 描述 |
|---|---|
| pagesize | 最大显示行数（预设值：100） 该应用程序介面将只显示最多1000行数据。如果要检索1000行以上的数据，请将其与”offset”结合使用（请参阅以下示例） 格式： pagesize=最大显示行数的数量 例子： pagesize=10 |
| offset | 返回结果中要偏移的行数。 格式： offset=偏移量 例子： offset=50 |
| fields | 用于显示选定的字段（默认：显示每个API文档中定义的所有字段） 格式： fields=field1,field2…. 例子： fields=end_of_month Notes: For API “Register of Securities Staff of AIs (eRegister)”, only applied to fields [name_en, name_tc, current_registration, business_address, conditions, registration_history, public_disciplinary_action] |
| column,filter | column: 用于输入参数”filter”的字段名称 filter: 用于输入数字或日期中定义字段的值 如数据类型为文字，请使用使用引号（””）和逗号（,）来分隔值 数字和日期格式： column=field name&filter=field value1,field value2 文字格式： column=field name&filter=”field value1″,”field value2″ 数字和日期例子： column=end_of_month&filter=1997-01,1997-02 文字例子： column=address&filter=”15/F, central…”,”16/F, wai chai….” Notes: Not applied to API “Register of Securities Staff of AIs (eRegister)” |
| choose,from,to | choose: 用于输入参数”from”和”to”的字段名称（结果将大于或等于较低值，小于或等于较高值） from: 用于输入数字或日期中定义哪个字段的较低值 to: 用于输入数字或日期中定义哪个字段的较高值 格式： column=field name&from=lower value&to=higher value 例子： choose=end_of_month&from=1997-01&to=1997-12 Notes: Not applied to API “Register of Securities Staff of AIs (eRegister)” |
| sortby,sortorder | sortby: 用于输入排序顺序的字段名称。 sortorder: 用于输入排序顺序 格式： sortby=field name&sortorder=asc|desc 例子： sortby=end_of_month&sortorder=desc Notes: Not applied to API “Register of Securities Staff of AIs (eRegister)” |
回应值(JSON)
| 回应字段 | 描述 |
|---|---|
| success | 识别JSON是否返回成功 |
| err_code | 返回错误代码 |
| err_msg | 返回简要说明 |
| datasize | 返回记录数目 |
| records | 用于返回配对结果 |