新北市政府資料開放平臺

OpenAPI Specification（OAS）

OAS藉由一致性的描述方法，提供人類及機器都能夠直接理解與使用的API說明文件，藉由網路間應用程式介面的共通語言，降低了資訊的溝通成本，讓服務的串聯更加便利。

OAS閱讀與試用請參考：

本網站之開發應用／OpenAPI，或點擊網址https://data.ntpc.gov.tw/openapi/swagger-ui/index.html?configUrl=/api/v1/openapi/swagger/config。

1. 基本查詢
   URL格式：https://data.ntpc.gov.tw/api/datasets/{dataSetOid}/{format}/{method}
2. 
   {dataSetOid}：資料代碼，可於各資料集頁面之網址最後一段取得。
3. {format}：資料格式，提供json、xml、csv三種格式。
4. {method}：下載方式，提供file、zip兩種方式。
5. 
   範例一、新北市路邊停車空位查詢（部分資料預覽）
   https://data.ntpc.gov.tw/api/datasets/54A507C4-C038-41B5-BF60-BBECB9D052C6/csv
6.  
7. 範例二、新北市路邊停車空位查詢（完整下載）（僅CSV格式適用，JSON、XML格式請使用進階查詢）
8. https://data.ntpc.gov.tw/api/datasets/54A507C4-C038-41B5-BF60-BBECB9D052C6/csv/file
9.  
10. 範例三、新北市路邊停車空位查詢（完整下載並壓縮）（僅CSV格式適用）
11. https://data.ntpc.gov.tw/api/datasets/54A507C4-C038-41B5-BF60-BBECB9D052C6/csv/zip

1. 進階查詢
   URL格式一：https://data.ntpc.gov.tw/api/datasets/{dataSetOid}/{format}?{page}&{size}
2. 
   {page}：取得資料頁碼，ex. 「page=0」為存取第一頁。
   {size}：每頁資料筆數，ex「size=100」為一頁呈現100筆資料。
3.  

1. URL格式二：https://data.ntpc.gov.tw/api/datasets/{dataSetOid}{format}?${filter}
2.  

1. {filter}：關鍵字查詢，格式為「filter={欄位名稱}(空格)eq(空格){值} 」，ex.「filter=ID eq 5109」為取得關鍵字"ID"等於"5109"的資料。
2. 註：空格符號將在網址中被轉換為"%20"
3. 
   範例一、
   https://data.ntpc.gov.tw/api/datasets/54A507C4-C038-41B5-BF60-BBECB9D052C6/xml?page=0&size=2
   
   $format=xml，代表資料格式為xml；
   $page=0，為取得第1頁資料；
   $size=2，為每頁呈現2筆資料。
4.  
5. 範例二、
6. https://data.ntpc.gov.tw/api/datasets/54A507C4-C038-41B5-BF60-BBECB9D052C6/xml?$filter=ID%20eq%205109
7.  
8. $format=xml，代表資料格式為xml；
9. $filter=ID%20eq%205109，為取得"ID"等於"5109"的資料。
10.  

1. 
   檔案格式
   JSON、CSV、XML
   
   
   其他事項
   1. 如資料內容有TWD97的欄位，當定位的正確性不夠時，系統會給予0表示定位失敗。
   
   2. 『新北市公有路外停車場即時賸餘車位數』、『新北市垃圾清運車輛所在位置』為即時資料，系統每三分鐘更新。如您有大量及高頻率之資料介接需求時，請讓我們知道，以免因大量介接造成平台效能不彰，影響雙方作業。
   
   3. 『新北市公車預估到站時間』為即時資料，系統每兩分鐘更新，如您有大量及高頻率之資料介接需求時，請讓我們知道，以免因大量介接造成平台效能不彰，影響雙方作業。