使用說明

中央氣象署開放資料平臺提供各式資料,為能優化開放資料的服務,本平臺採用會員服務機制。如尚未成為本署氣象會員,請先至本署官網申請註冊(只需有效的郵件帳號,就可免費線上申請),再登入本平臺,即可透過網頁連結下載資料,或發展程式介接進行檔案下載或資料擷取。

成為會員除可享有本署官網提供之會員服務外,並可取得本平臺所提供之各式開放資料;當有資料格式異動、新增或下架資料、系統停機維護、等重要公告時,會員將會收到系統同步通知之電子郵件。

以下分別說明本平臺提供之資料取用方式:

一、透過網站連結下載

於氣象資料開放平臺登入後,於網站中的各資料頁面,直接點選連結下載檔案。即日起檔案下載與資料擷取API之服務僅支援https網址,不再提供http轉址服務。

二、發展程式介接

本平臺提供透過URL下載檔案以及 RESTful / GraphQL API 資料擷取方法取用資料,惟因本平臺採用會員服務機制,需帶入資料項目代碼以及有效會員之授權碼,方可取得各式開放資料。其中,資料項目代碼可至資料清單列表查詢,會員之授權碼可於登入會員後點選下方按鈕取得

1.取得授權碼。

2.檔案下載-使用說明及範例

※使用說明:可透過URL方式取得資料檔案,須帶入資料項目代碼以及有效之授權碼,格式{format}為選填。

※快取功能說明:透過URL取得資料後,將Response header的{ETAG}代入下一次的Request header的{If-None-Match} 或請參考連結

                    
※ URL: https://opendata.cwa.gov.tw/fileapi/v1/opendataapi/{dataid}?Authorization={apikey}&format={format}
{dataid} 為資料編號 (參照:資料清單) ex.F-A0012-001
{apikey} 為會員帳號對應之授權碼 ex.CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678
{format} 為資料格式,請參照各資料集頁面確認可下載之檔案格式 ex.XML、CAP、JSON、ZIP、KMZ
※ 範例:https://opendata.cwa.gov.tw/fileapi/v1/opendataapi/F-A0012-001?Authorization=CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678&format=XML
並請加入快取功能,如上述所示。

3.資料擷取-使用說明及目前開放資料擷取之氣象資料 線上API使用說明

※使用說明:可開發 RESTful API 之 Client 程式擷取資料內容,須以URL帶入資料項目代碼以及各資料項目提供查詢之參數設定,並以 HTTP 基本認證(HTTP Basic Authentication)確認授權身分,兩種認證方式如下:

(1) 在 URL 參數帶入有效之會員授權碼,例如:

                    
※ URL:https://opendata.cwa.gov.tw/api/v1/rest/datastore/{dataid}?Authorization={apikey}&format={format}
{dataid} 為資料編號 (參照:資料清單) ex.F-C0032-001
{apikey} 為會員帳號對應之授權碼 ex.CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678
{format} 為回傳資料格式 ex.XML、JSON(預設)
※ 範例:https://opendata.cwa.gov.tw/api/v1/rest/datastore/F-C0032-001?Authorization=CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678&format=XML
詳細參數設定請參考上方連結(線上API使用說明)

(2) 在 HTTP header 裡設定屬性 Authorization 的值為會員授權碼,使用方式請參考 連結

若同時使用兩種認證方式,則以 HTTP header 的認證為主。如果 HTTP header 認證失敗,立即返回認證失敗訊息,而非再進行 URL 認證。

4.短期過去資料下載-使用說明及範例 線上API使用說明

※使用說明:可開發 RESTful API 之 Client 程式,取得短期過去資料的詮釋資訊與下載網址。

(1) 取得支援短期過去資料的所有資料編號清單,須帶入有效之授權碼查詢。

                    
※ URL: https://opendata.cwa.gov.tw/historyapi/v1/getDataId/?Authorization={apikey}
{apikey} 為會員帳號對應之授權碼 ex.CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678
※ 範例:https://opendata.cwa.gov.tw/historyapi/v1/getDataId/?Authorization=CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678

(2) 取得[指定資料編號]短期過去資料基本資訊,須帶入資料項目代碼以及有效之授權碼,可查詢包含資料名稱、供應期間範圍、更新頻率、說明文件等相關描述。

                    
※ URL: https://opendata.cwa.gov.tw/historyapi/v1/getDataId/{dataid}?Authorization={apikey}
{dataid} 為資料編號 (參照:取得支援短期過去資料的所有資料編號清單) ex. O-A0059-001
{apikey} 為會員帳號對應之授權碼 ex.CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678
※ 範例:https://opendata.cwa.gov.tw/historyapi/v1/getDataId/O-A0059-001?Authorization=CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678

(3) 取得[指定資料編號]短期過去資料檔案清單,須帶入資料項目代碼以及有效之授權碼,格式{format}、{limit}、{offset}、{timeFrom}、{timeTo}為選填。API回傳內容之url即為檔案下載網址,可透過此網址取得特定時間的過去資料。

                    
※ URL: https://opendata.cwa.gov.tw/historyapi/v1/getMetadata/{dataid}?Authorization={apikey}&format={format}&limit={limit}&offset={offset}&timeFrom={timeFrom}&timeTo={timeTo}
{dataid} 為資料編號 (參照:取得支援短期過去資料的所有資料編號清單) ex. O-A0059-001
{apikey} 為會員帳號對應之授權碼 ex.CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678
{format} 為回傳資料格式ex.XML、JSON
{limit} 為限制最多回傳的資料
{offset} 為指定從第幾筆後開始回傳
{timeFrom} 為時間區段, 篩選需要之時間區段,時間從「timeFrom」開始篩選,直到內容之最後時間
{timeTo} 為時間區段, 篩選需要之時間區段,時間從內容之最初時間開始篩選,直到「timeTo」
※ 範例:https://opendata.cwa.gov.tw/historyapi/v1/getMetadata/O-A0059-001?Authorization=CWA-1234ABCD-78EF-GH90-12XY-IJKL12345678

5.開放鏈結資料-使用說明及範例 線上API使用說明

※使用說明:可開發 GraphQL API 之 Client 程式擷取開放鏈結資料內容,須於URL帶入有效之會員授權碼,並在 HTTP Header帶入有效之GraphQL查詢語法。

詳細介面規格、參數定義與範例說明請參考上方連結(線上API使用說明)。

氣象領域資料標準說明

為統一規範氣象署對外供應或交換之資料,訂定明確的資料結構並提供欄位說明,做為氣象資料內容之遵循標準,本平臺開放資料將依序導入此「氣象領域資料標準」。

規範內容可點選連結下載說明文件參考