API 使用說明

一、會員註冊取得API Key

(1) 本平臺提供透過 API 取用資料,惟因本平臺採用會員服務機制,需帶入會員之 API 金鑰,方可取得各式開放資料。

(2) 於會員註冊 (https://data.epa.gov.tw/api_term) 後,平臺將寄出會員之 API 金鑰信件。

(3) 登入會員後,至基本資料頁面,取得會員之 API 金鑰登入會員後,至基本資料頁面,取得會員之 API 金鑰


二、以「資料擷取API線上說明文件」存取資料,供應用程式介接

(1) 至「資料擷取API線上說明文件」取得 API URL

步驟一:點擊「開發指南」>「資料擷取API線上說明文件」資料擷取API線上說明文件

步驟二:點擊欲取得資料的資料集,再點擊「Try it out」點擊Try it out

步驟三:每個資料集 API 各有其可運用的參數,以「空氣品質指標(AQI) 」資料集為例,可使用以下圖之三項參數。填入參數後,點擊「Execute」。可使用此圖之三項參數。填入參數後,點擊「Execute」

步驟四:以「空氣品質指標(AQI) 」資料集為例,可取得 API URL:
https://data.epa.gov.tw/api/v1/aqx_p_432?offset=0&limit=1000&api_key=your-api-key

(2) API 參數說明
API URL 格式如下:
https://data.epa.gov.tw/api/v1/{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
{year_month} 歷史資料時間,請填入格式為 yyyy_mm,例如 2020_01,未填則取得最新資料
{filters} 欲針對特定欄位進行篩選,可以使用{欄位名稱},{運算子},{值},若有多個條件,可以使用「|」分開,可以使用的{運算子}有:EQ(等於),GR(大於),LE(小於),LIKE(包含),舉例,想要搜尋2020-07-25到2020-07-30,在汐止地區空氣品質良好的資料,可以使用如下:filters=SiteName,EQ,汐止|PublishTime,GR,2020-07-25|PublishTime,LE,2020-07-30|Status,LIKE,良好

(3) 下載[年_月]打包資料方式:
[年_月]打包資料方式
1. 可依API月分參數下載結構化資料:
https://data.epa.gov.tw/api/v1/aqx_p_185?format=json&limit=5&year_month=2019_03&api_key=f8146cb1-193c-4a9a-812a-9c84c9ef87b9

2. 如上圖所示,亦可於資料集頁面下載預先壓縮打包之月分資料:
http://opendata2.epa.gov.tw/data/aqx_p_185/aqx_p_185_2019-03.zip



(4) API下載三種格式範例:
除API常用之json格式外,亦可下載csv與xml格式
API下載三種格式
API下載CSV格式
API下載XML格式