API 使用說明
:::
(2) API 參數說明
(3) 下載[年_月]打包資料方式:
一、會員註冊取得API Key
(1) 本平臺提供透過 API 取用資料,惟因本平臺採用會員服務機制,需帶入會員之 API 金鑰,方可取得各式開放資料。
(2) 於會員註冊
( https://data.moenv.gov.tw/api_term)
後,平臺將寄出會員之 API 金鑰信件。
(3) 請妥善保存信件中的 API 金鑰。
二、API參數說明、Python及R語言範例,歡迎參考使用,手冊請至 https://reurl.cc/W3oAzk
下載。
三、以「資料擷取API線上說明文件」存取資料,供應用程式介接
(1) 至「資料擷取API線上說明文件」取得 API URL步驟一:點擊「開發指南」>「資料擷取API線上說明文件」
步驟二:點擊欲取得資料的資料集,再點擊「Try it out」
步驟三:每個資料集 API 各有其可運用的參數,以「空氣品質指標(AQI)」資料集為例,可使用以下圖之三項參數。填入參數後,點擊「Execute」。
步驟四:以「空氣品質指標(AQI) 」資料集為例,可取得 API URL:
https://data.moenv.gov.tw/api/v2/aqx_p_432?offset=0&limit=1000&api_key=your-api-key
(2) API 參數說明
API URL 格式如下:
https://data.moenv.gov.tw/api/v2/{DataID}?format={format}&year_month={yyyy_mm}&offset={offset}&limit={limit}&api_key={api-key}
{DataID} | 資料代號,可透過「資料擷取API線上說明文件」取得,如上圖步驟四所示。 |
---|---|
{limit} | 取 n 筆資料,請填入數字。 |
{offset} | 跳過筆數,請填入數字。 |
{api_key} | 資料下載會員 API 金鑰,「會員註冊」後可取得。 |
{sort} | 用來排序之欄位名稱,可使用「欄位名稱asc」為遞增排序,「欄位名稱 desc」為遞減排序,預設為遞減排序 |
{format} | 資料格式,請填入json, xml, csv |
{yyyy_mm} | 歷史資料時間,請填入例如 2020_01,未填則取得最新資料 |
{DataID} |
(3) 下載[年_月]打包資料方式: