如何使用香港開放數據 API
透過 mcp.hk 搜尋數據集、檢查來源及讀取支援的記錄,並分清目錄資料、查詢能力及來源可靠程度。
1. 找到合適的數據集
先搜尋目錄,選擇與問題相關的數據集。目錄項目只描述來源,並不代表 mcp.hk 一定能讀取當中的記錄。部分來源須指定參數、工作表、JSON 記錄路徑,或另行開發轉接器。
curl "https://mcp.hk/api/v1/catalogue/datasets?q=public%20holidays"
2. 查詢前先檢查來源
列出數據集的來源,查看格式、存取狀態、供應者及來源網址。先用 schema 端點檢查支援的欄位,再查詢所需記錄。來源被拒絕存取、尚未支援、暫停或讀取失敗,都不代表數據集沒有記錄。
GET /api/v1/resources?datasetId=DATASET_ID POST /api/v1/resources/RESOURCE_ID/schema POST /api/v1/resources/RESOURCE_ID/query
3. 保留查證依據
保留回應提供的原始來源網址、標示、參考期、警告、擷取及檢查時間,以及快照識別碼。即使成功讀取來源,當中的觀測數據仍可能過時。用於回答或分析前,應先確認欄位意思及單位。