應用程式介面規格

香港金融管理局現提供以下應用程式介面:

使用香港金融管理局應用程式介面

規範:

https://api.hkma.gov.hk/public/api_uri?parameters…
api_url 請參考各類別的應用程式介面規格。
至於可選的參數,請參考以下的「參數(可選)」

參數(可選)

參數名稱 描述
pagesize 最大顯示行數(預設值:100)
該應用程序介面將只顯示最多100行數據。如果要檢索100行以上的數據,請將其與"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 用於返回配對結果