API
WebAPIの概要
当サイトの「グラフで見る」及び「データで見る」で表示しているデータは、機械判読可能な形式
（XML、JSON、CSV等）で出力するREST方式のWebAPI（Application Programming Interface）でも公開しています。
（当該WebAPIを利用することで「グラフで見る」及び「データで見る」のページを実装しています。）
本APIは利用登録不要で、誰でもお使いいただけます。（サイトポリシーを御確認の上、御利用ください。）
取得できるデータの構造
本APIから取得できるデータは、下図の例に示すとおり、
系列ごとに3次元に整形化しています。
約6,000の系列を保持しており、各系列は「時間」軸、「地域」軸を持ちます。
系列によって、「時間」軸に月単位のデータや四半期単位のデータが無い場合や、「地域」軸に国のデータや市区町村のデータが無い（調査していない）ものもあります。
（詳細は提供データ一覧を参照してください。）
値を一意に定めるには、「系列」、「時間」及び「地域」を決定する必要があります。
（「系列」及び「地域」を決定すれば時系列のグラフに、「系列」及び「時間」を決定すれば地域別のグラフになります。）
「系列」は、下表の例に示すとおり、［データ周期］、
［地域階級］及び
［原数値・季節調整値］により細分化されます。
これを「系列要素」と呼びます。「系列要素」ごとに出典（参照している大元の統計調査）や注記
が異なり、「系列」内でも単位が異なることもあります。
| 系列名 | 系列コード | データ周期 | 地域階級 | 原数値・季調値 | 系列要素コード | 出典 | 単位 |
|---|---|---|---|---|---|---|---|
| 就業者（男） | 0301010001010010010 | 月 | 全国（日本） | 原数値 | 0301010001010010010010201 | 労働力調査 | 万人 |
| 季節調整値 | 0301010001010010010010202 | 労働力調査 | 万人 | ||||
| 四半期 | 全国（日本） | 原数値 | 0301010001010010010020201 | 労働力調査 | 万人 | ||
| 年 | 全国（日本） | 原数値 | 0301010001010010010030201 | 労働力調査 | 万人 | ||
| 国 | 原数値 | 0301010001010010010030101 | ILOSTAT | 千人 | |||
| 年度 | 全国（日本） | 原数値 | 0301010001010010010040201 | 労働力調査 | 万人 | ||
| 住宅数 | 0801010100000010000 | 年 | 全国（日本） | 原数値 | 0801010100000010000030201 | 住宅・土地統計調査 | 戸 |
| 都道府県 | 原数値 | 0801010100000010000030301 | SSDS | 戸 | |||
| 市区町村 | 原数値 | 0801010100000010000030401 | SSDS | 戸 |
【系列要素コードの説明】
先頭19桁 ＝ 系列コードと同じ
20～21桁 ＝ データ周期（01：月、02：四半期、03：年、04：年度）
22～23桁 ＝ 地域階級（01：国、02：全国（日本）、03：都道府県、04：市区町村）
24～25桁 ＝ 原数値・季調値（01：原数値、02：季調値）
※系列コードの詳細については、系列コード体系：xlsxを参照してください。
「系列」、「系列要素」及び「データ」の連関図は以下のとおりです。
「系列」及び「系列要素」の具体例は上表のとおりですが、「データ」の具体例は以下のとおりです。
| （系列要素名） | 系列要素コード | 地域 | 時間 | 値 |
|---|---|---|---|---|
| 住宅数[年、全国（日本）、原数値] | 0801010100000010000030201 | 全国（日本） | 1948年 | 13,907,024 |
| 0801010100000010000030201 | 全国（日本） | 1958年 | 17,934,000 | |
| ： | ： | ： | ： | |
| 0801010100000010000030201 | 全国（日本） | 2013年 | 60,628,600 | |
| 住宅数[年、都道府県、原数値] | 0801010100000010000030301 | 北海道 | 1978年 | 1,744,500 |
| 0801010100000010000030301 | 北海道 | 1983年 | 1,923,800 | |
| ： | ： | ： | ： | |
| 0801010100000010000030301 | 北海道 | 2013年 | 2,746,600 | |
| 0801010100000010000030301 | 青森県 | 1978年 | 411,400 | |
| 0801010100000010000030301 | 青森県 | 1983年 | 444,900 | |
| ： | ： | ： | ： | |
| 0801010100000010000030301 | 青森県 | 2013年 | 586,300 | |
| ： | ||||
| 0801010100000010000030301 | 沖縄県 | 1978年 | 303,000 | |
| 0801010100000010000030301 | 沖縄県 | 1983年 | 338,200 | |
| ： | ： | ： | ： | |
| 0801010100000010000030301 | 沖縄県 | 2013年 | 602,800 | |
| ： | ： | ： | ： |
WebAPIの使い方
本APIは下表の6つの機能を提供します。
| No. | 機能名 | 概要 |
|---|---|---|
| ① | 統計メタ情報（系列）取得 | 「系列」に関する情報を統計調査名や分野指定で検索し、取得します。 |
| ② | 統計メタ情報（地域）取得 | 「地域」に関する情報を地域名や地域コードで検索し、取得します。 |
| ③ | 統計メタ情報（用語）取得 | 「用語」に関する情報をフリーワードや分野指定で検索し、取得します。 |
| ④ | 統計メタ情報（社会事象）取得 | 「社会事象」に関する情報を発生時や分野指定で検索し、取得します。 |
| ⑤ | 統計メタ情報（統計調査）取得 | 「統計情報」に関する情報をフリーワードや分野指定で検索し、取得します。 |
| ⑥ | 統計データ取得 | 統計データを系列コードや地域、時間等で検索し、取得します。 |
基本的な使い方としては、まず①「統計メタ情報（系列）取得」で取得したいデータの[系列コード]を検索し、
その後⑥「統計データ取得」で[系列コード]を検索条件に指定し、その系列の情報を取得します。
（②③④⑤は補助的な情報として独立して取得できるようにしています。データのみ必要な場合は当該機能は不要です。）
具体的な使い方は、以下の「WebAPIの詳細仕様」に記載する[ベースURL]に検索条件となる[パラメータ]を"&"で連結し、HTTPリクエスト（GET）を送信することで目的のデータを取得できます。
各パラメータは「パラメータ名=値」のように名称と値を'='で結合し、複数のパラメータを指定する場合は「パラメータ名=値&パラメータ名=値&…」のようにそれぞれのパラメータ指定を'&'で結合してください。
また、パラメータ値は必ずURLエンコード(文字コードUTF-8)してから結合してください。
WebAPIの詳細仕様
本APIの6つの機能におけるそれぞれのベースURLや検索条件のパラメータ、結果のレスポンスフィールド等は下表のとおりです。
また、取得できるデータの公開形式は、[XML,JSON,CSV]形式です（⑥「統計データ取得」のJSONについては、統計データの提供に特化した
[JSON-stat]形式でも公開しています。）。
| No. | 機能名 | 公開形式 | ベースURL | パラメータ・レスポンス | 出力サンプル | ||
|---|---|---|---|---|---|---|---|
| ① | 統計メタ情報（系列）取得 | XML | https://dashboard.e-stat.go.jp/api/1.0/Xml/getIndicatorInfo? |
（ダウンロード） |
（ダウンロード） |
|
|
| JSON | https://dashboard.e-stat.go.jp/api/1.0/Json/getIndicatorInfo? |
|
|||||
| CSV | https://dashboard.e-stat.go.jp/api/1.0/Csv/getIndicatorInfo? |
|
|||||
| ② | 統計メタ情報（地域）取得 | XML | https://dashboard.e-stat.go.jp/api/1.0/Xml/getRegionInfo? |
（ダウンロード） |
（ダウンロード） |
|
|
| JSON | https://dashboard.e-stat.go.jp/api/1.0/Json/getRegionInfo? |
|
|||||
| CSV | https://dashboard.e-stat.go.jp/api/1.0/Csv/getRegionInfo? |
|
|||||
| ③ | 統計メタ情報（用語）取得 | XML | https://dashboard.e-stat.go.jp/api/1.0/Xml/getTermInfo? |
（ダウンロード） |
（ダウンロード） |
|
|
| JSON | https://dashboard.e-stat.go.jp/api/1.0/Json/getTermInfo? |
|
|||||
| CSV | https://dashboard.e-stat.go.jp/api/1.0/Csv/getTermInfo? |
|
|||||
| ④ | 統計メタ情報（社会事象）取得 | XML | https://dashboard.e-stat.go.jp/api/1.0/Xml/getSocialEventInfo? |
（ダウンロード） |
（ダウンロード） |
|
|
| JSON | https://dashboard.e-stat.go.jp/api/1.0/Json/getSocialEventInfo? |
|
|||||
| CSV | https://dashboard.e-stat.go.jp/api/1.0/Csv/getSocialEventInfo? |
|
|||||
| ⑤ | 統計メタ情報（統計調査）取得 | XML | https://dashboard.e-stat.go.jp/api/1.0/Xml/getStatInfo? |
（ダウンロード） |
（ダウンロード） |
|
|
| JSON | https://dashboard.e-stat.go.jp/api/1.0/Json/getStatInfo? |
|
|||||
| CSV | https://dashboard.e-stat.go.jp/api/1.0/Csv/getStatInfo? |
|
|||||
| ⑥ | 統計データ取得 | XML | https://dashboard.e-stat.go.jp/api/1.0/Xml/getData? |
（ダウンロード） |
（ダウンロード） |
|
|
| JSON | https://dashboard.e-stat.go.jp/api/1.0/Json/getData? |
|
|||||
| JSON-stat | https://dashboard.e-stat.go.jp/api/1.0/JsonStat/getData? |
|
|||||
| CSV | https://dashboard.e-stat.go.jp/api/1.0/Csv/getData? |
|
|||||
|
※ CORS(Cross Origin Resource Sharing)対応 上表の[JSON]及び[JSON-stat]形式のリクエストURLは、クロスオリジンリソースシェアリング(CORS)に対応しています。 XMLHttpRequest(Level 2)に対応しているブラウザであれば、XMLHttpRequestを利用してクロスドメイン通信をすることが可能です。 |
（一括版） | （処理結果コード一覧） | |||||
|
（ダウンロード） |
（ダウンロード） |
（ダウンロード） |
（ダウンロード） |
||||
注意事項
・本APIは利用登録不要で、誰でもお使いいただけますが、サイトポリシーを遵守して御利用ください。
・本ホームページに掲載されているAPI仕様を確認した上で御利用ください。
・本APIを使用したサービスを公開する場合には、下記のクレジット表示をお願いします。
「このサービスは、統計ダッシュボードのAPI機能を使用していますが、サービスの内容は国によって保証されたものではありません。」
（利用される方が参照できる場所であれば、表示場所の指定はございません。）
・法律、規則、条例等の制定法に反する行為、又はそれを勧誘・助長する行為は行わないでください。
・虚偽の情報をコンテンツに掲載し、閲覧者を欺く行為は行わないでください。
・短時間における大量のアクセス等により、本APIの運営、又はネットワークやシステムを妨害する行為は行わないでください。
・本APIに関わるシステムの点検や保守作業を行う場合、本APIの全部または一部を停止または中断することがあります。
・本API仕様変更時にはAPIを利用した既存アプリケーションが稼動しなくなる場合がありますので、予めご了承ください。