e-Stat API 怎麼用：使用者登錄、應用程式 ID 與統計資料取得請求的 4 個步驟

本站談過許多日本官方統計，例如本站「日本 CPI 怎麼看」「日本貿易統計怎麼看」「日本失業率怎麼看」等文。這類政府統計可以在「政府統計の総合窓口（e-Stat）」查詢，網站除了人工下載，也提供 API，讓使用者用程式取得資料。對想長期追蹤日本統計的人來說，API 可以避免每個月手動下載同一份表。本篇依 e-Stat 的 API 利用指南、API 使用方法與信用標示頁面，說明使用 API 的 4 個步驟、請求的格式、必要參數與公開時的標示。本篇只說明 API 的使用方法，不引用任何統計數值；API 版本與統計表 ID 會依統計改版而變，實作前請以 e-Stat 官方的最新 API 規格為準。與本篇互補的篇章有〈日本家計調查怎麼讀：二人以上世帶的消費支出與樣本設計〉，以及〈日本景氣動向指數怎麼讀：先行、一致、遲行指數與 CI、DI〉和〈日銀時系列統計資料檢索網站怎麼用：下載利率與匯率資料〉。

e-Stat API 是什麼

e-Stat 的 API 頁面說明：提供能以機器可判讀的格式，取得 e-Stat 所公開的統計資料的 API 機能。頁面也特別預告，版本 3.0 起可以取得小地區與地區網格資料。API 機能「任何人都可以使用」，但需要先在 e-Stat 完成使用者登錄。

4 件步驟

利用指南把使用流程分成 4 件步驟：

1. 使用者登錄：使用 API 機能需先在 e-Stat 登錄使用者；
2. 取得應用程式 ID：呼叫 API 時必須送出應用程式 ID。登入 e-Stat 的「My 頁面」，在「API 機能（應用程式 ID 發行）」中，依每個開發的應用程式取得；登錄時填入的名稱、URL、概要事後可以變更，不公開時 URL 可用本機位址；
3. 確認 API 規格並開發應用程式：依官網公布的 API 規格開發；
4. 公開應用程式：必要時公開所開發的應用程式。

請求怎麼寫

e-Stat 的「API 使用方法」頁面用範例說明：以統計資料取得 API（getStatsData）為例，請求網址的格式是

http://api.e-stat.go.jp/rest/<版本>/app/getStatsData?<參數群>

若要取得 JSON，改用 .../rest/<版本>/app/json/getStatsData?<參數群>。頁面範例取得的是東京都的老年人口比例（社會・人口統計體系）。

請求的參數規則有 3 件：

1. 必要的參數是 appId（應用程式 ID）與 statsDataId（統計表 ID），其他參數都可省略；
2. 參數用「參數名＝值」的形式，多個參數用「&」連接；
3. 參數值必須先以 UTF-8 做 URL 編碼，再結合。

省略可選參數時，有些參數（例如 lang、statsNameList）會採預設值。要指定項目時，例如範例中的 cdCat01，可以篩選想取得的項目；不指定則取得全部項目。需要注意：範例網址中的版本是 2.0，而官方規格頁已有 3.0 版，實際使用時請確認目前可用的版本與參數。

信用標示與公開

若公開使用 e-Stat API 的服務，e-Stat 請求標示信用：「このサービスは、政府統計総合窓口(e-Stat)のAPI機能を使用していますが、サービスの内容は国によって保証されたものではありません。」標示位置沒有指定，只要使用者看得到即可。API 頁面也說明，公開的應用程式可能被介紹為 API 的活用事例。

怎麼做

使用 API 可做 5 件確認：

1. 在 e-Stat 登錄使用者並登入。
2. 取得應用程式 ID，並妥善保存。
3. 從統計表頁面找到想取得的統計表 ID。
4. 用瀏覽器或程式測試 getStatsData 請求，先試少量參數。
5. 若要公開服務，e-Stat 請求加上信用標示。

容易踩雷

使用 API 時的 4 件誤解：

• 忽略登錄與應用程式 ID，直接送請求。
• 沒有做 URL 編碼，造成參數錯誤。
• 以為範例的版本與統計表 ID 永遠有效；統計改版時會變。
• 公開服務卻沒有標示信用（e-Stat 為「請求」標示，仍建議照辦）。

常見問題

任何人都可以用 API 嗎？

可以（共 4 件步驟），但需先在 e-Stat 登錄使用者並取得應用程式 ID。

請求最少要哪些參數？

appId 與 statsDataId。

要取得 JSON 怎麼辦？

在請求路徑加上 json，例如 .../app/json/getStatsData。

公開服務要標示什麼？

e-Stat 請求標示信用，說明服務內容不由國家保證。