政府統計の総合窓口(e-Stat)のAPI 仕様 2.1版

平成 28 年 7月
独立行政法人 統計センター

本ページは、政府統計の総合窓口(e-Stat)のAPI機能に係る仕様について説明したものです。

目次

1. API機能の種類

2. APIの利用方法

3. APIパラメータ

4. APIの出力データ

1. API機能の種類

取り扱うデータの種類や操作内容により、以下の7つの機能を提供します。

  • 統計表情報取得
  • 政府統計の総合窓口(e-Stat)で提供している統計表の情報を取得します。リクエストパラメータの指定により条件を絞った情報の取得も可能です。

  • メタ情報取得
  • 指定した統計表IDに対応するメタ情報(表章事項、分類事項、地域事項等)を取得します。

  • 統計データ取得
  • 指定した統計表ID又はデータセットIDに対応する統計データ(数値データ)を取得します。

  • データセット登録
  • 統計データを取得する際の取得条件を登録します。統計データの取得における絞り込み条件を「データセット」として指定することで、取得条件を省略することができます。

  • データセット参照
  • 登録されているデータセットの絞り込み条件等を参照します。データセットIDが指定されていない場合は、利用者が使用できるデータセットの一覧が参照可能です。

  • データカタログ情報取得
  • 政府統計の総合窓口(e-Stat)で提供している統計表ファイルおよび統計データベースの情報を取得できます。統計表情報取得機能同様に、リクエストパラメータの指定により条件を絞った情報の取得も可能です。

  • 統計データ一括取得
  • 複数の統計表ID又はデータセットIDを指定して一括で統計データ(数値データ)を取得します。

2. APIの利用方法

指定されたURLに対してリクエストを送信することで、各APIを利用することができます。URLで取得するデータ形式を選択できます。

各APIを利用するには、アプリケーションIDを必ず指定する必要があります。利用登録を行い、アプリケーションIDを取得して下さい。

2.1. 統計表情報取得

リクエストURL
(XML形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/getStatsList?<パラメータ群>
リクエストURL
(JSON形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/json/getStatsList?<パラメータ群>
リクエストURL
(JSONP形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/jsonp/getStatsList?<パラメータ群>
HTTPメソッド GET

2.2. メタ情報取得

リクエストURL
(XML形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/getMetaInfo?<パラメータ群>
リクエストURL
(JSON形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/json/getMetaInfo?<パラメータ群>
リクエストURL
(JSONP形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/jsonp/getMetaInfo?<パラメータ群>
HTTPメソッド GET

2.3. 統計データ取得

リクエストURL
(XML形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/getStatsData?<パラメータ群>
リクエストURL
(JSON形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/json/getStatsData?<パラメータ群>
リクエストURL
(JSONP形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/jsonp/getStatsData?<パラメータ群>
リクエストURL
(CSV形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/getSimpleStatsData?<パラメータ群>
HTTPメソッド GET

2.4. データセット登録

リクエストURL http://api.e-stat.go.jp/rest/<バージョン>/app/postDataset
HTTPメソッド POST
Content-Type application/x-www-form-urlencoded

※ データセット登録の場合はPOSTで送信して下さい。また、HTTPヘッダに上記の通り’Content-Type’の指定が必要です。

2.5. データセット参照

リクエストURL
(XML形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/refDataset?<パラメータ群>
リクエストURL
(JSON形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/json/refDataset?<パラメータ群>
リクエストURL
(JSONP形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/jsonp/refDataset?<パラメータ群>
HTTPメソッド GET

2.6. データカタログ情報取得

リクエストURL
(XML形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/getDataCatalog?<パラメータ群>
リクエストURL
(JSON形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/json/getDataCatalog?<パラメータ群>
リクエストURL
(JSONP形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/jsonp/getDataCatalog?<パラメータ群>
HTTPメソッド GET

2.7. 統計データ一括取得

リクエストURL
(XML形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/getStatsDatas?<パラメータ群>
リクエストURL
(JSON形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/json/getStatsDatas?<パラメータ群>
リクエストURL
(CSV形式)
http://api.e-stat.go.jp/rest/<バージョン>/app/getSimpleStatsDatas?<パラメータ群>
HTTPメソッド POST

3. APIパラメータ

各APIは、リクエスト送信時にパラメータの指定が必要です。

各パラメータは「パラメータ名=値」のように名称と値を’=’で結合し、複数のパラメータを指定する場合は「パラメータ名=値&パラメータ名=値&…」のようにそれぞれのパラメータ指定を’&’で結合して下さい。また、パラメータ値は必ずURLエンコード(文字コードUTF-8)してから結合して下さい。

リクエスト方式がGETの場合は「2.APIの利用方法」の各リクエストURLの<パラメータ群>の位置に、POSTの場合はリクエストのボディ部に、それぞれ 結合した文字列を指定して下さい。

3.1. 全API共通

パラメータ名 意味 必須 設定内容・設定可能値
appId アプリケーションID 取得したアプリケーションIDを指定して下さい。
lang 言語 取得するデータの言語を 以下のいずれかを指定して下さい。
・J:日本語 (省略値)
・E:英語

3.2. 統計表情報取得

パラメータ名 意味 必須 設定内容・設定可能値
surveyYears 調査年月 以下のいずれかの形式で指定して下さい。
・yyyy:単年検索
・yyyymm:単月検索
・yyyymm-yyyymm:範囲検索
openYears 公開年月 調査年月と同様です。
statsField 統計分野 以下のいずれかの形式で指定して下さい。
・数値2桁:統計大分類で検索
・数値4桁:統計小分類で検索
statsCode 政府統計コード 以下のいずれかの形式で指定して下さい。
・数値5桁:作成機関で検索
・数値8桁:政府統計コードで検索
searchWord 検索キーワード 任意の文字列
表題やメタ情報等に含まれている文字列を検索します。
AND、OR 又は NOT を指定して複数ワードでの検索が可能です。 (東京 AND 人口、東京 OR 大阪 等)
searchKind 検索データ種別 検索するデータの種別を指定して下さい。
・1:統計情報(省略値)
・2:小地域・地域メッシュ
・3:社会・人口統計体系(都道府県・市区町村のすがた)
statsNameList 統計調査名指定 統計表情報でなく、統計調査名の一覧を取得する場合に指定して下さい。
・Y:統計調査名一覧
統計調査名一覧を出力します。
statsNameListパラメータを省略した場合、又はY以外の値を設定した場合は統計表情報を出力します。
startPosition データ取得開始位置 データの取得開始位置(1から始まる行番号)を指定して下さい。省略時は先頭から取得します。
統計データを複数回に分けて取得する場合等、継続データを取得する開始位置を指定するために指定します。
前回受信したデータの<NEXT_KEY>タグの値を指定します。
limit データ取得件数 データの取得行数を指定して下さい。省略時は10万件です。
データ件数が指定したlimit値より少ない場合、全件を取得します。データ件数が指定したlimit値より多い場合(継続データが存在する)は、受信したデータの<NEXT_KEY>タグに継続データの開始行が設定されます。
updatedDate 更新日付 更新日付を指定します。指定された期間で更新された統計表の情報)を提供します。以下のいずれかの形式で指定して下さい。
・yyyy:単年検索
・yyyymm:単月検索
・yyyymmdd:単日検索
・yyyymmdd-yyyymmdd:範囲検索
callback コールバック関数 JSONP形式のデータ呼出の場合は必須パラメータです。
コールバックされる関数名を指定して下さい。

3.3. メタ情報取得

パラメータ名 意味 必須 設定内容・設定可能値
statsDataId 統計表ID 「統計表情報取得」で得られる統計表IDです。
callback コールバック関数 JSONP形式のデータ呼出の場合は必須パラメータです。
コールバックされる関数名を指定して下さい。

3.4. 統計データ取得

パラメータ名 意味 必須 設定内容・設定可能値
dataSetId データセットID ※1,2 「データセット登録」で登録したデータセットID です。
statsDataId 統計表ID ※1 「統計表情報取得」で得られる統計表IDです。
lvTab 絞り込み条件 ※2 表章事項 階層レベル 以下のいずれかの形式で指定して下さい。
(Xは「メタ情報取得」で得られる各メタ情報の階層レベル)
・X:指定階層レベルのみで絞り込み
・X-X:指定階層レベルの範囲で絞り込み
・-X:階層レベル1 から指定階層レベルの範囲で絞り込み
・X-:指定階層レベルから階層レベル 9 の範囲で絞り込み
cdTab 単一コード※3 特定の項目コードでの絞り込み
「メタ情報取得」で得られる各メタ情報の項目コードを指定して下さい。
コードはカンマ区切りで100個まで指定可能です。
cdTabFrom コード From※3 項目コードの範囲で絞り込み
絞り込む範囲の開始位置の項目コードを指定して下さい。
cdTabTo コード To※3 項目コードの範囲で絞り込み
絞り込む範囲の終了位置の項目コードを指定して下さい。
lvTime 時間軸事項 階層レベル 表章事項の階層レベルと同様です。
cdTime 単一コード 表章事項の単一コードと同様です。
cdTimeFrom コード From 表章事項のコード Fromと同様です。
cdTimeTo コード To 表章事項のコード Toと同様です。
lvArea 地域事項 階層レベル 表章事項の階層レベルと同様です。
cdArea 単一コード 表章事項の単一コードと同様です。
cdAreaFrom コード From 表章事項のコード Fromと同様です。
cdAreaTo コード To 表章事項のコード Toと同様です。
lvCat01 分類事項01 階層レベル 表章事項の階層レベルと同様です。
cdCat01 単一コード 表章事項の単一コードと同様です。
cdCat01From コード From 表章事項のコード Fromと同様です。
cdCat01To コード To 表章事項のコード Toと同様です。
・・・ 分類事項02 ~ 15 分類事項01と同様です。
startPosition データ取得開始位置 データの取得開始位置(1から始まる行番号)を指定して下さい。
省略時は先頭から取得します。
統計データを複数回に分けて取得する場合等、継続データを取得する開始位置を指定するために指定します。
前回受信したデータのタグの値を指定します。
limit データ取得件数 データの取得行数を指定して下さい。省略時は10万件です。
データ件数が指定したlimit値より少ない場合、全件を取得します。データ件数が指定したlimit値より多い場合(継続データが存在する)は、受信したデータのタグに継続データの開始行が設定されます。
metaGetFlg メタ情報有無 統計データと一緒にメタ情報を取得するか否かを以下のいずれかから指定して下さい。
・Y:取得する (省略値)
・N:取得しない
cntGetFlg 件数取得フラグ 指定した場合、件数のみ取得できます。metaGetFlg=Yの場合は、メタ情報も同時に返却されます。
・Y:件数のみ取得する。統計データは取得しない。
・N:件数及び統計データを取得する。(省略値)
callback コールバック関数 JSONP形式のデータ呼出の場合は必須パラメータです。
コールバックされる関数名を指定して下さい。
sectionHeaderFlg セクションヘッダフラグ CSV形式のデータ呼び出しの場合に有効なパラメータです。
・1:セクションヘッダを出力する (省略値)
・2:セクションヘッダを取得しない

※1 データセットID 又は 統計表ID のいずれか一方を必ず指定して下さい。どちらも指定しない場合や両方指定した場合はエラーとなります。

※2 データセットID を指定した場合、そのデータセットに登録されている絞り込み条件を元にデータを取得します。
データセットIDと絞り込み条件を指定した場合は、データセットに登録されている条件から更に絞り込むことができます。

※3 以下の特別なキーワードを指定可能です。
min:最小値
max:最大値
min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。
単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。

3.5. データセット登録

パラメータ名 意味 必須 設定内容・設定可能値
dataSetId データセットID ※1 30文字以内の任意の文字列で半角英数字と’-‘、’_’、’.’、’@’のみ使用可 です。
省略時は「政府統計コード(8桁)-年月日時分秒(14桁)-枝番(1桁)」の形式で自動付与されます。(「-枝番(1桁)」の部分はない場合あり)
statsDataId 統計表ID ※1 「統計表情報取得」で得られる統計表IDです。
lvTab 絞り込み条件 ※2 表章事項 階層レベル 以下のいずれかの形式で指定して下さい。 (Xは「メタ情報取得」で得られる各メタ情報の階層レベル)
・X:指定階層レベルのみで絞り込み
・X-X:指定階層レベルの範囲で絞り込み
・-X:階層レベル1 から指定階層レベルの範囲で絞り込み
・X-:指定階層レベルから階層レベル 9 の範囲で絞り込み
cdTab 単一コード※3 特定の項目コードでの絞り込み
「メタ情報取得」で得られる各メタ情報の項目コードを指定して下さい。
コードはカンマ区切りで100個まで指定可能です。
cdTabFrom コード From※3 項目コードの範囲で絞り込み
絞り込む範囲の開始位置の項目コードを指定して下さい。
cdTabTo コード To※3 項目コードの範囲で絞り込み
絞り込む範囲の終了位置の項目コードを指定して下さい。
lvTime 時間軸事項 階層レベル 表章事項の階層レベルと同様です。
cdTime 単一コード 表章事項の単一コードと同様です。
cdTimeFrom コード From 表章事項のコード Fromと同様です。
cdTimeTo コード To 表章事項のコード Toと同様です。
lvArea 地域事項 階層レベル 表章事項の階層レベルと同様です。
cdArea 単一コード 表章事項の単一コードと同様です。
cdAreaFrom コード From 表章事項のコード Fromと同様です。
cdAreaTo コード To 表章事項のコード Toと同様です。
lvCat01 分類事項01 階層レベル 表章事項の階層レベルと同様です。
cdCat01 単一コード 表章事項の単一コードと同様です。
cdCat01From コード From 表章事項のコード Fromと同様です。
cdCat01To コード To 表章事項のコード Toと同様です。
・・・ 分類事項02 ~ 15 分類事項01と同様です。
openSpecified 公開可否 登録したデータセットを公開するか否かを指定して下さい。
0:公開不可 (他の利用者は参照・利用不可) (省略値)
1:公開可 (他の利用者も参照・利用可)
processMode 処理モード ※1 以下のいずれかを指定して下さい。
E:登録・更新(新規データセットの登録又は既存データセットの更新) (省略値)
D:削除(既存データセットの削除)
dataSetName データセット名 データセットの名称、内容、説明等を指定して下さい。
全角で256文字まで指定可能です。

※1 登録の場合は、処理モードを’E’とした上で統計表IDと1つ以上の絞り込み条件の指定が必須となります。
更新の場合は、処理モードを’E’とした上で統計表IDとデータセットID及び1つ以上の絞り込み条件の指定が必須となります。
削除の場合は、処理モードを’D’とした上でデータセットIDが必須となります。

※2 同一事項に対して階層レベルと項目コードの絞り込み条件を併用した場合はAND条件となります。
単一コードとコード範囲(From-To)を併用した場合もAND条件になります。コード範囲(From-To)の指定はFromのみ、Toのみの指定も可能です。Fromのみの場合は指定コード以降すべて、Toのみの場合は指定コード以前すべてが対象となります。

※3 以下の特別なキーワードを指定可能です。
min:最小値
max:最大値
min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。
単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。

3.6. データセット参照

パラメータ名 意味 必須 設定内容・設定可能値
dataSetId データセットID 「データセット登録」で登録したデータセットIDです。
省略時は 利用可能なデータセットの一覧を取得します。
callback コールバック関数 JSONP形式のデータ呼出の場合は必須パラメータです。
コールバックされる関数名を指定して下さい。

3.7. データカタログ情報取得

パラメータ名 意味 必須 設定内容・設定可能値
surveyYears 調査年月 以下のいずれかの形式で指定して下さい。
・yyyy:単年検索
・yyyymm:単月検索
・yyyymm-yyyymm:範囲検索
openYears 公開年月 調査年月と同様です。
statsField 統計分野 以下のいずれかの形式で指定して下さい。
・数値2桁:統計大分類で検索
・数値4桁:統計小分類で検索
statsCode 政府統計コード 以下のいずれかの形式で指定して下さい。
・数値5桁:作成機関で検索
・数値8桁:政府統計コードで検索
searchWord 検索キーワード 任意の文字列
表題やメタ情報等に含まれている文字列を検索します。
AND 、OR 又は NOT を指定して複数ワードでの検索が可能です。 (東京 AND 人口、東京 OR 大阪 等)
dataType 検索データ形式 以下の値を指定して下さい。
・XLS:EXCELファイル
・CSV:CSVファイル
・PDF:PDFファイル
・DB:統計データベース
カンマ区切りで複数指定可能です。
省略時はすべてを指定した場合と同じです。
startPosition データ取得開始位置 データの取得開始位置(1から始まる番号)を指定して下さい。省略時は先頭から取得します。
統計表情報を複数回に分けて取得する場合等、継続データを取得する開始位置(データセット)を指定するために指定します。
前回受信したデータの<NEXT_KEY>タグの値を指定します。
catalogId カタログID 検索するカタログIDを指定してください。
resourceId カタログリソースID 検索するカタログリソースIDを指定してください。
limit データ取得件数 データの取得データセット数を指定して下さい。省略時は100データセットです。
データセット数が指定したlimit値より少ない場合、全件を取得します。データセット数が指定したlimit値より多い場合(継続データが存在する)は、受信したデータの<NEXT_KEY>タグに継続データの開始位置が設定されます。
updatedDate 更新日付 更新日付を指定します。指定された期間で更新されたデータセットの情報を提供します。以下のいずれかの形式で指定して下さい。
・yyyy:単年検索
・yyyymm:単月検索
・yyyymmdd:単日検索
・yyyymmdd-yyyymmdd:範囲検索
callback コールバック関数 JSONP形式のデータ呼出の場合は必須パラメータです。
コールバックされる関数名を指定して下さい。

3.8. 統計データ一括取得

パラメータ名 意味 必須 設定内容・設定可能値
metaGetFlg メタ情報有無 統計データと一緒にメタ情報を取得するか否かを以下のいずれかから指定して下さい。
・Y:取得する (省略値)
・N:取得しない
sectionHeaderFlg セクションヘッダフラグ CSV形式のデータ呼び出しの場合に有効なパラメータです。
・1:セクションヘッダを出力する (省略値)
・2:セクションヘッダを取得しない
statsDatasSpec 統計データ一括取得パラメータリスト ※1※2 一括取得する統計データIDおよびその絞込条件等を既出したリストです。JSON形式の文字列を記述します。

※1 指定できるパラメータは以下になります。

パラメータ名 意味 必須 設定内容・設定可能値
dataSetId データセットID ※1-1, ※1-2 「データセット登録」で登録したデータセットID です。
statsDataId 統計表ID ※1-1 「統計表情報取得」で得られる統計表IDです。
lvTab 絞り込み条件 ※1-2 表章事項 階層レベル 以下のいずれかの形式で指定して下さい。 (Xは「メタ情報取得」で得られる各メタ情報の階層レベル)
・X:指定階層レベルのみで絞り込み
・X-X:指定階層レベルの範囲で絞り込み
・-X:階層レベル1 から指定階層レベルの範囲で絞り込み
・X-:指定階層レベルから階層レベル 9 の範囲で絞り込み
cdTab 単一コード ※1-3 特定の項目コードでの絞り込み
「メタ情報取得」で得られる各メタ情報の項目コードを指定して下さい。
コードはカンマ区切りで100個まで指定可能です。
cdTabFrom コード From ※1-3 項目コードの範囲で絞り込み
絞り込む範囲の開始位置の項目コードを指定して下さい。
cdTabTo コード To ※1-3 項目コードの範囲で絞り込み
絞り込む範囲の終了位置の項目コードを指定して下さい。
lvTime 時間軸事項 階層レベル 表章事項の階層レベルと同様です。
cdTime 単一コード 表章事項の単一コードと同様です。
cdTimeFrom コード From 表章事項のコード Fromと同様です。
cdTimeTo コード To 表章事項のコード Toと同様です。
lvArea 地域事項 階層レベル 表章事項の階層レベルと同様です。
cdArea 単一コード 表章事項の単一コードと同様です。
cdAreaFrom コード From 表章事項のコード Fromと同様です。
cdAreaTo コード To 表章事項のコード Toと同様です。
lvCat01 分類事項01 階層レベル 表章事項の階層レベルと同様です。
cdCat01 単一コード 表章事項の単一コードと同様です。
cdCat01From コード From 表章事項のコード Fromと同様です。
cdCat01To コード To 表章事項のコード Toと同様です。
・・・ 分類事項02 ~ 15 分類事項01と同様です。
startPosition データ取得開始位置 データの取得開始位置(1から始まる行番号)を指定して下さい。省略時は先頭から取得します。
統計データを複数回に分けて取得する場合等、継続データを取得する開始位置を指定するために指定します。
前回受信したデータのタグの値を指定します。
Limit データ取得件数 データの取得行数を指定して下さい。省略時は10万件です。
データ件数が指定したlimit値より少ない場合、全件を取得します。
データ件数が指定したlimit値より多い場合(継続データが存在する)は、受信したデータのタグに継続データの開始行が設定されます。

※1-1 データセットID 又は 統計表ID のいずれか一方を必ず指定して下さい。
どちらも指定しない場合や両方指定した場合はエラーとなります。

※1-2 データセットID を指定した場合、そのデータセットに登録されている絞り込み条件を元にデータを取得します。
データセットIDと絞り込み条件を指定した場合は、データセットに登録されている条件から更に絞り込むことができます。

※1-3 以下の特別なキーワードを指定可能です。
min:最小値
max:最大値
min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。
単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。

※2 パラメータは、以下のように取得する統計データ単位にその絞込条件と共にJSON形式で記述します。

[ { "statsDataId" : "0003084821", "lvTab" : "1-2", "cdCat01" : "01" }, { "statsDataId" : "0005084822", "cdAreaFrom" : "01000", "cdAreaTo" : "02000" }, { "statsDataId" : "0005084823", "cdAreaFrom" : "02000", "cdAreaTo": "02000" } ]
JSON記述形式
1つのリクエストは連想配列で表現します。中括弧 ”{”で囲みます。

パラメータ名とその値はダブルクォートクォートし、コロン”:”で連結します。

複数指定する場合、カンマ ”,”で連結します。
JSON記述形式
複数のリクエストは配列で表現します。大括弧 ”[”で囲みます。

リクエストの連想配列は、カンマ”,”で連結します。
■リクエスト番号について 連想配列で記述された各リクエストは先頭から順番に1から始まる連番がリクエスト番号として付与される。 リクエスト番号の付与はサーバ側において自動的に行われます。 リクエスト番号はエラー発生時にどのリクエストでエラーが発生したかを関連付けする等に使用します。

4. APIの出力データ

各APIは、XML形式のデータを返却します (JSON形式、JSONP形式およびCSV形式のデータフォーマットを指定した場合を除く) 。

ルートタグ名やスキーマ名、API毎の出力部のタグ名はAPIにより異なりますが、基本的には以下のように3つのブロックで構成されます。


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<GET_STATS_LIST
xsi:noNamespaceSchemaLocation="http://<ホスト名>/api/<バージョン>/schema/GetStatsList.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RESULT> ・・・ APIの処理結果情報 </RESULT>
<PARAMETER> ・・・ APIが受信したパラメータ情報 </PARAMETER>
<DATALIST_INF> ・・・ API毎の出力部 <DATALIST_INF>
</GET_STATS_LIST>

JSON形式のデータはXML形式のデータを元に次の変換表に従い変換します。さらに全体を中括弧 { } で囲みます。

XML形式 JSON形式
基本的な変換 <親要素名>

<子要素名1>文字型値</子要素名1>
<子要素名2>数値</子要素名2>

</親要素名>

“親要素名”:{

“子要素名1”:”文字型値”,
“子要素名2”:数値

}

属性がある場合 <要素名 属性名=”属性値”>

要素値

</要素名>

“要素名”:{

“@属性名”:”属性値”,
“$”:”要素値”

}

同名タグがある場合 <要素名>要素値1</要素名>
<要素名>要素値2</要素名>
・・・
“要素名”:[

{“$”:”要素値1”},
{“$”:”要素値2”},
・・・

]

JSONP形式でデータを取得する場合、コールバックパラメータ(callback)が必須となります。コールバック関数に渡されるJSON形式のデータはJSON形式と同じです。

JSON出力における文字のエスケープ処理

■JSON出力では全角文字をユニコードエスケープします。

XML出力
<PARAMETER>
  <LANG>J</LANG>
  <DATA_FORMAT>X</ DATA_FORMAT>
  <SEARCH_WORD>国勢調査</SEARCH_WORD>
  <LIMIT>1000</LIMIT>
</PARAMETER>
JSON出力
"PARAMETER": {
  "LANG": "J",
  "DATA_FORMAT": "J"
  "SEARCH_WORD": <SEARCH_WORD>国勢調査</SEARCH_WORD>
JSON出力では全角文字はユニコードエスケープされます。
"\u56FD\u52E2"
"LIMIT": "1000" },

*以降のJSON出力のサンプルでは、可読性の観点から全角文字をエスケープなしで表記します。

■JSON出力では以下の半角文字をユニコードエスケープします。

<

>

&

=

⇒¥u003c

⇒¥u003e

⇒¥u0026

⇒¥u003d

⇒¥u0027 (シングルクォート)

■JSON出力では、ダブルクォート(“)およびバックスラッシュ(¥)文字等はバックスラッシュでエスケープします。

CSV形式では、以下の共通ルールに従います。
・出力はダブルクォート文字(")でクォートします。
・項目の区切りはカンマ文字(,)で区切ります。
・項目にダブルクォートが含まれる場合、ダブルクォートでエスケープします。例 「a”b」 ⇒ a””b」
・出力行は、タグ名、タグ値の順番で出力します。

4.1. 全API共通

4.1.1. RESULT タグ

すべてのAPI共通で、以下の要素を出力します。

タグ名 内容
RESULT APIの処理結果情報を出力します。
STATUS APIの処理結果をコードで表します。
0 ~ 2の場合は正常終了、100 以上の場合はエラーです。
ERROR_MSG STATUSの値に対応するエラーメッセージです。
DATE このXMLデータが出力された日時です。

4.1.2. 処理結果コード

RESULT要素の結果コード(STATUS)とメッセージ(ERROR_MSG)及びHTTPステータスの一覧を以下に示します。





H
T
T
P




メッセージ 意味
















































0 200 正常に終了しました。 正常終了。
1 200 正常に終了しましたが、該当データはありませんでした。 正常終了(結果0件:該当データ無し)。
2 200 正常に終了しましたが、リクエスト番号({0})で該当データはありませんでした。 統計データ一括取得時のメッセージ。
{0}にはリクエスト番号が出力されます。複数あった場合、カンマ区切りで出力されます。
100 403 認証に失敗しました。ユーザーID、パスワードを確認して下さい。 認証エラー(アプリケーションIDに誤りがある)の場合に出力されます。
101 400 {0}を指定して下さい。 必須パラメータが指定されていない場合に出力されます。
{0}にはパラメータ名が出力されます。
102 400 {0}の値が正しくありません。 パラメータに指定されている値が無効値(有効範囲外等)の場合に出力されます。
{0}にはパラメータ名が出力されます。
103 400 {0}の値が長すぎます。{1}バイト以内で指定して下さい。 パラメータに指定されている値の長さが制限値を超えている場合に出力されます。
{0}にはパラメータ名が出力されます。{1}には制限値が出力されます
104 400 {0}に使用できる文字は{1}です。 パラメータに指定されている値に許可されていない文字が含まれている場合に出力されます。
{0}にはパラメータ名が出力されます。{1}には使用可能な文字が出力されます。
105 400 {0}の値が多すぎます。100個以内で指定して下さい。 絞り込み条件で単一コードの指定制限数を超えて指定した場合に出力されます。
{0}にはパラメータ名が出力されます。
200 500 データベース(統計データ)にアクセス中にエラーが発生しました。時間をおいてからやり直してみて下さい。改善しない場合は管理者に問い合わせて下さい。 データベースアクセス時に発生する内部エラーです。
201 500 データベース(データセット)にアクセス中にエラーが発生しました。時間をおいてからやり直してみて下さい。改善しない場合は管理者に問い合わせて下さい。 データベースアクセス時に発生する内部エラーです。
202 500 データベース(利用者マスタ)にアクセス中にエラーが発生しました。時間をおいてからやり直してみて下さい。改善しない場合は管理者に問い合わせて下さい。 データベースアクセス時に発生する内部エラーです。
203 500 データベース(補完データ)にアクセス中にエラーが発生しました。時間をおいてからやり直してみて下さい。改善しない場合は管理者に問い合わせて下さい。 データベースアクセス時に発生する内部エラーです。
299 500 予期しないエラーが発生しました。管理者に問い合わせて下さい。 処理中に発生する内部エラーです。
300 400 {0}=[{1}]のデータは存在しません。IDを確認して下さい。 パラメータに指定されている値のデータが存在しない場合(存在しないデータの統計表ID等)に出力されます。
{0}にはパラメータ名が出力されます。{1}にはパラメータの指定値が出力されます。
301 200 このデータを更新・削除する権限がありません。 データセット変更時に、他のアプリケーションIDのデータセットを指定した場合に出力されます。
302 200 絞り込み条件を適用した結果、抽出件数が0件となるため登録出来ません。絞り込み条件を見直して下さい。 データセット登録・更新時に、絞り込み結果が0件となる場合に出力されます。
303 500 データセットIDの自動付与に失敗しました。時間をおいてからやり直すか、任意のデータセットIDを指定して下さい。 データセット登録時に、データセットIDの自動生成に失敗した場合に出力されます。
400 200 返却セルデータ数が多すぎます。全体で100000件以内になるように絞込条件を指定して下さい。 統計データ一括取得時のメッセージ。統計データ一括取得ではすべてのリクエストの取得行数の合計が制限されます。(100000件)
401 500 リクエスト番号 {0} でエラー{1}を検出しました。{2} 統計データ一括取得時のエラーメッセージ。
{0}にはエラーが発生したリクエスト番号が出力されます。
{0}には発生したエラーの結果コードが出力されます。(統計データ取得で出力される結果コード)
{1}には発生した結果コードに対応するエラーメッセージが出力されます。(統計データ取得で出力されるエラーメッセージ)

4.2. 統計表情報取得

ルートタグは<GET_STATS_LIST>です。

4.2.1. PARAMETER タグ

リクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別のAPIのパラメータを指定した場合は出力されません。

タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATA_FORMAT 出力フォーマット形式
「X」:XML形式
「J」:JSON形式又はJSONP形式
SURVEY_YEARS 調査年月
OPEN_YEARS 公開年月
STATS_FIELD 統計分野
STATS_CODE 政府統計コード
SMALL_AREA 小地域
SEARCH_WORD 検索キーワード
SEARCH_KIND 検索データ種別
STATS_NAME_LIST 統計調査名一覧指定
START_POSITION データ取得開始位置
LIMIT データ取得件数
UPDATED_DATE 更新日付
CALLBACK コールバック関数

4.2.2. DATALIST_INF タグ

統計表情報を出力します。エラーがあった場合はこのタグ自体出力されません。

タグ名 内容
DATALIST_INF 統計表情報を出力します。
NUMBER 出力される統計表の件数です。
RESULT_INF 取得開始行、取得終了行および次回開始行の情報を保持します。
FROM_NUMBER データの開始位置です。
TO_NUMBER データの終了位置です。
NEXT_KEY 継続データ存在時の次のデータ開始位置です。
TABLE_INF 統計表の情報をNUMBERの件数分出力します。属性として統計表ID(id)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
CYCLE 統計表の提供周期です。
SURVEY_DATE 統計の調査年月です。
OPEN_DATE 統計表の公開日です。
SMALL_AREA 小地域属性のフラグです。
MAIN_CATEGORY 統計大分野名です。属性として統計大分野コード(code)を保持します。
SUB_CATEGORY 統計小分野名です。属性として統計小分野コード(code)を保持します。
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。
UPDATED_DATE 統計データの最終更新日です。
STATISTICS_NAME_SPEC 統計表の提供統計名及び提供分類名の詳細です。
TABULATION_CATEGORY 統計表の提供統計名を保持します。
TABULATION_SUB_CATEGORY1 統計表提供分類名1を保持します。
TABULATION_SUB_CATEGORY2 統計表提供分類名2を保持します。
TABULATION_SUB_CATEGORY3 統計表提供分類名3を保持します。
TABULATION_SUB_CATEGORY4 統計表提供分類名4を保持します。
TABULATION_SUB_CATEGORY5 統計表提供分類名5を保持します。
TITLE_SPEC 統計表の表題の詳細です。
TABLE_CATEGORY 表分類名を保持します。
TABLE_NAME 表名を保持します。
TABLE_SUB_CATEGORY1 表名区分1を保持します。
TABLE_SUB_CATEGORY2 表名区分2を保持します。
TABLE_SUB_CATEGORY3 表名区分3を保持します。

統計調査名一覧指定の場合は以下が出力されます。

タグ名 内容
DATALIST_INF 統計表情報を出力します。
NUMBER 出力される統計表の件数です。
RESULT_INF 取得開始行、取得終了行および次回開始行の情報を保持します。
FROM_NUMBER データの開始位置です。
TO_NUMBER データの終了位置です。
NEXT_KEY 継続データ存在時の次のデータ開始位置です。
LIST_INF 統計調査の情報をNUMBERの件数分出力します。属性として政府統計コード(id)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。

4.2.3. XML形式出力サンプル


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_STATS_LIST
xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/<バージョン>/schema/GetStatsList.xsd" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2015-01-07T17:20:57.716+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <SURVEY_YEARS>201001-201212</SURVEY_YEARS>
        <STATS_FIELD>03</STATS_FIELD>
        <STATS_CODE>00200</STATS_CODE>
        <SEARCH_WORD>就業構造基本調査</SEARCH_WORD>
        <SEARCH_KIND>1</SEARCH_KIND>
        <DATA_FORMAT>X</DATA_FORMAT>
        <LIMIT>1000</LIMIT>
    </PARAMETER>
    <DATALIST_INF>
        <NUMBER>543</NUMBER>
        <RESULT_INF>
            <FROM_NUMBER>1</FROM_NUMBER>
            <TO_NUMBER>543</TO_NUMBER>
        </RESULT_INF>
        <TABLE_INF id="0003084821">
            <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME>
            <GOV_ORG code="00200">総務省</GOV_ORG>
            <STATISTICS_NAME>平成24年就業構造基本調査 全国編</STATISTICS_NAME>
            <TITLE no="00100">男女,就業状態・仕事の主従,就業希望意識・就業希望の有無,求職活動の有無,世帯主との続き柄,一般・単身世帯,配偶関係,年齢別15歳以上人口</TITLE>
            <CYCLE>-</CYCLE>
            <SURVEY_DATE>201210</SURVEY_DATE>
            <OPEN_DATE>2013-07-12</OPEN_DATE>
            <SMALL_AREA>0</SMALL_AREA>
            <MAIN_CATEGORY code="03">労働・賃金</MAIN_CATEGORY>
            <SUB_CATEGORY code="01">労働力</SUB_CATEGORY>
            <OVERALL_TOTAL_NUMBER>8208</OVERALL_TOTAL_NUMBER>
            <UPDATED_DATE>2014-02-10</UPDATED_DATE>
            <STATISTICS_NAME_SPEC>
                <TABULATION_CATEGORY>平成24年就業構造基本調査</TABULATION_CATEGORY >
                <TABULATION_SUB_CATEGORY1>全国編</TABULATION_SUB_CATEGORY1>
            </STATISTICS_NAME_SPEC>
            <TITLE_SPEC>
                <TABLE_NAME>男女,就業状態・仕事の主従,就業希望意識・就業希望の有無,求職活動の有無,世帯主との続き柄,一般・単身世帯,配偶関係,年齢別15歳以上人口</TABLE_NAME>
            </TITLE_SPEC>
        </TABLE_INF>
         ・・・
    </DATALIST_INF>
</GET_STATS_LIST>

パラメータに統計調査名一覧指定を指定した場合、以下のように出力されます。


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_STATS_LIST
 xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/<バージョン>/schema/GetStatsList.xsd"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2015-01-07T17:32:27.855+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <SURVEY_YEARS>201001-201212</SURVEY_YEARS>
        <STATS_FIELD>03</STATS_FIELD>
        <SEARCH_KIND>1</SEARCH_KIND>
        <STATS_NAME_LIST>Y</STATS_NAME_LIST>
        <DATA_FORMAT>X</DATA_FORMAT>
    </PARAMETER>
    <DATALIST_INF>
        <NUMBER>3</NUMBER>
        <RESULT_INF>
            <FROM_NUMBER>1</FROM_NUMBER>
            <TO_NUMBER>3</TO_NUMBER>
        </RESULT_INF>
        <LIST_INF id="00200531">
            <STAT_NAME code="00200531">労働力調査</STAT_NAME>
            <GOV_ORG code="00200">総務省</GOV_ORG>
        </LIST_INF>
         ・・・
    </DATALIST_INF>
</GET_STATS_LIST>


※JSON形式のデータも、XML形式のデータを元に変換されるため、同様の情報が出力されます。

4.3. メタ情報取得

ルートタグは<GET_META_INFO>です。

4.3.1. PARAMETER タグ

リクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別のAPIのパラメータを指定した場合は出力されません。

タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
STATS_DATA_ID 統計表ID
DATA_FORMAT 出力フォーマット形式
「X」:XML形式
「J」:JSON形式又はJSONP形式
CALLBACK コールバック関数

4.3.2. METADATA_INF タグ

メタ情報を出力します。エラーがあった場合はこのタグ自体出力されません。

タグ名 内容
METADATA_INF メタ情報を出力します。
TABLE_INF 指定した統計表の情報を出力します。属性として統計表ID(id)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。
TITLE 表統計表の題です。属性として表番号(no)を保持します。
CYCLE 統計表の提供周期です。
SURVEY_DATE 統計の調査年月です。
OPEN_DATE 統計表の公開日です。
SMALL_AREA 小地域属性のフラグです。
MAIN_CATEGORY 統計大分野名です。属性として統計大分野コード(code)を保持します。
SUB_CATEGORY 統計小分野名です。属性として統計小分野コード(code)を保持します。
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。
UPDATED_DATE 統計データの最終更新日です。
STATISTICS_NAME_SPEC 統計表の提供統計名及び提供分類名の詳細です。
TABULATION_CATEGORY 統計表の提供統計名を保持します。
TABULATION_SUB_CATEGORY1 統計表提供分類名1を保持します。
TABULATION_SUB_CATEGORY2 統計表提供分類名2を保持します。
TABULATION_SUB_CATEGORY3 統計表提供分類名3を保持します。
TABULATION_SUB_CATEGORY4 統計表提供分類名4を保持します。
TABULATION_SUB_CATEGORY5 統計表提供分類名5を保持します。
TITLE_SPEC 統計表の表題の詳細です。
TABLE_CATEGORY 表分類名を保持します。
TABLE_NAME 表名を保持します。
TABLE_SUB_CATEGORY1 表名区分1を保持します。
TABLE_SUB_CATEGORY2 表名区分2を保持します。
TABLE_SUB_CATEGORY3 表名区分3を保持します。
CLASS_INF 統計データのメタ情報を出力します。
CLASS_OBJ メタ情報の数分だけ出力します。属性としてメタ情報のID(id)、名称(name)及び解説(description)を保持します。解説はデータがある場合のみ出力されます。
CLASS メタ情報を構成する要素の数分だけ出力します。属性としてメタ情報要素のコード(code)、名称(name)、階層レベル(level)、単位(unit)、親コード(parentCode)及び追加情報(addInf)を保持します。単位、親コード及び追加情報はデータがある場合のみ出力されます。

4.3.3. XML形式出力サンプル


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_META_INFO
xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/<バージョン>/schema/GetMetaInfo.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2015-01-07T17:38:32.441+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <STATS_DATA_ID>0003090287</STATS_DATA_ID>
        <DATA_FORMAT>X</DATA_FORMAT>
    </PARAMETER>
    <METADATA_INF>
        <TABLE_INF id="0003090287">
            <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME>
            <GOV_ORG code="00200">総務省</GOV_ORG>
            <STATISTICS_NAME>平成24年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏) 世帯単位で見た統計表</STATISTICS_NAME>
            <TITLE no="410101">世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県</TITLE>
            <CYCLE>-</CYCLE>
            <SURVEY_DATE>201210</SURVEY_DATE>
            <OPEN_DATE>2014-03-20</OPEN_DATE>
            <SMALL_AREA>0</SMALL_AREA>
            <MAIN_CATEGORY code="03">労働・賃金</MAIN_CATEGORY>
            <SUB_CATEGORY code="01">労働力</SUB_CATEGORY>
            <OVERALL_TOTAL_NUMBER>1392</OVERALL_TOTAL_NUMBER>
            <UPDATED_DATE>2014-03-19</UPDATED_DATE>
            <STATISTICS_NAME_SPEC>
                <TABULATION_CATEGORY>平成24年就業構造基本調査</TABULATION_CATEGORY >
                <TABULATION_SUB_CATEGORY1>地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏)</TABULATION_SUB_CATEGORY1>
                <TABULATION_SUB_CATEGORY2>世帯単位で見た統計表</TABULATION_SUB_CATEGORY2>
            </STATISTICS_NAME_SPEC>
            <TITLE_SPEC>
                <TABLE_NAME>世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県</TABLE_NAME>
            </TITLE_SPEC>
        </TABLE_INF>
        <CLASS_INF>
            <CLASS_OBJ id="tab" name="表章項目">
                <CLASS code="006" name="世帯数" level="" unit="世帯"/>
            </CLASS_OBJ>
            <CLASS_OBJ id="cat01" name="世帯家族類型,夫妻の就業状態・有業の親有無-2012">
                <CLASS code="000" name="総数" level="1"/>
                <CLASS code="001" name="夫婦のみの世帯" level="2"/>
                <CLASS code="002" name="夫婦ともに有業" level="3"/>
                <CLASS code="003" name="夫が有業で妻が無業" level="3"/>
                <CLASS code="004" name="夫が無業で妻が有業" level="3"/>
                 ・・・
            </CLASS_OBJ>
            <CLASS_OBJ id="area" name="地域2012">
               <CLASS code="00000" name="全国" level="1"/>
                <CLASS code="01000" name="北海道" level="2" parentCode="00000"/>
                <CLASS code="02000" name="青森県" level="2" parentCode="00000"/>
                <CLASS code="03000" name="岩手県" level="2" parentCode="00000"/>
                 ・・・
            </CLASS_OBJ>
            <CLASS_OBJ id="time" name="時間軸(年次)">
                <CLASS code="2012000000" name="2012年" level="1"/>
            </CLASS_OBJ>
        </CLASS_INF>
    </METADATA_INF>
</GET_META_INFO>


※JSON形式のデータも、XML形式のデータを元に変換されるため、同様の情報が出力されます。

4.4. 統計データ取得

ルートタグは<GET_STATS_DATA>です。

4.4.1. PARAMETER タグ

リクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別のAPIのパラメータを指定した場合は出力されません。

タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATASET_ID データセットID
STATS_DATA_ID 統計表ID
NARROWING_COND 絞り込み条件
LEVEL_TAB_COND 表章事項のレベル指定
CODE_TAB_SELECT 表章事項の単一コード指定
CODE_TAB_FROM 表章事項のコードの範囲(開始)指定
CODE_TAB_TO 表章事項のコードの範囲(終了)指定
LEVEL_TIME_COND 時間軸事項のレベル指定
CODE_TIME_SELECT 時間軸事項の単一コード指定
CODE_TIME_FROM 時間軸事項のコードの範囲(開始)指定
CODE_TIME_TO 時間軸事項のコードの範囲(終了)指定
LEVEL_AREA_COND 地域事項のレベル指定
CODE_AREA_SELECT 地域事項の単一コード指定
CODE_AREA_FROM 地域事項のコードの範囲(開始)指定
CODE_AREA_TO 地域事項のコードの範囲(終了)指定
LEVEL_CAT01_COND 分類事項01のレベル指定
CODE_CAT01_SELECT 分類事項01の単一コード指定
CODE_CAT01_FROM 分類事項01のコードの範囲(開始)指定
CODE_CAT01_TO 分類事項01のコードの範囲(終了)指定
・・・ ※ 分類事項は 01 から 15 まで
DATA_FORMAT データフォーマット
「X」:XML形式
「J」:JSON形式又はJSONP形式
START_POSITION データ出力開始位置
LIMIT 取得データ件数
METAGET_FLG メタ情報出力有無
CNT_GET_FLG 件数取得フラグ
CALLBACK JSONPコールバック関数(JSONPの場合のみ)

4.4.2. STATISTICAL_DATA タグ

統計データの情報を出力します。エラーがあった場合はこのタグ自体出力されません。

タグ名 内容
STATISTICAL_DATA 統計データの情報を出力します。
RESULT_INF 取得開始行、取得終了行、次回開始行の情報および統計データの件数を保持します。
TOTAL_NUMBER 絞込条件に一致する統計データの件数です。
FROM_NUMBER データの開始位置です。
TO_NUMBER データの終了位置です。
NEXT_KEY 継続データ存在時の次のデータ開始位置です。
TABLE_INF 指定した統計表又は指定したデータセットが指し示す統計データの情報を出力します。属性として統計表ID(id)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
CYCLE 統計表の提供周期です。
SURVEY_DATE 統計の調査年月です。
OPEN_DATE 統計表の公開日です。
SMALL_AREA 小地域属性のフラグです。
MAIN_CATEGORY 統計大分野名です。属性として統計大分野コード(code)を保持します。
SUB_CATEGORY 統計小分野名です。属性として統計小分野コード(code)を保持します。
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。
UPDATED_DATE 統計データの最終更新日です。
STATISTICS_NAME_SPEC 統計表の提供統計名及び提供分類名の詳細です。
TABULATION_CATEGORY 統計表の提供統計名を保持します。
TABULATION_SUB_CATEGORY1 統計表提供分類名1を保持します。
TABULATION_SUB_CATEGORY2 統計表提供分類名2を保持します。
TABULATION_SUB_CATEGORY3 統計表提供分類名3を保持します。
TABULATION_SUB_CATEGORY4 統計表提供分類名4を保持します。
TABULATION_SUB_CATEGORY5 統計表提供分類名5を保持します。
TITLE_SPEC 統計表の表題の詳細です。
TABLE_CATEGORY 表分類名を保持します。
TABLE_NAME 表名を保持します。
TABLE_SUB_CATEGORY1 表名区分1を保持します。
TABLE_SUB_CATEGORY2 表名区分2を保持します。
TABLE_SUB_CATEGORY3 表名区分3を保持します。
CLASS_INF 統計データのメタ情報を出力します。
リクエストパラメータのメタ情報有無(metaGetFlg)に”N”(取得しない)を指定した場合、このタグは出力されません。
CLASS_OBJ メタ情報の数分だけ出力します。属性としてメタ情報のID(id)、名称(name)及び解説(description)を保持します。解説はデータがある場合のみ出力されます。
CLASS メタ情報を構成する要素の数分だけ出力します。属性としてメタ情報要素のコード(code)、名称(name)、階層レベル(level)、単位(unit)、親コード(parentCode)及び追加情報(addInf)を保持します。単位、親コード及び追加情報はデータがある場合のみ出力されます。指定した絞り込み条件又はデータセットの条件又はその両方の条件によって抽出されるメタ情報のみ出力されます。
DATA_INF 統計データの数値情報を出力します。
指定した絞り込み条件又はデータセットの条件又はその両方の条件によって抽出されるデータ件数が 0 の場合、このタグは出力されません。
また、件数取得フラグ(cntGetFlg)に”Y”(件数のみ取得する)を指定した場合も出力されません。
NOTE 特殊文字の凡例です。特殊文字の数分だけ出力されます。
属性として特殊文字(char)を保持します。
VALUE 統計数値(セル)の情報です。データ件数分だけ出力されます。
属性として表章事項コード(tab)、分類事項コード(cat01 ~ cat15)、地域事項コード(area)、時間軸事項コード(time)、単位(unit)を保持します。全ての属性はデータがある場合のみ出力されます。

件数取得フラグ指定の場合は以下が出力されます。

タグ名 内容
STATISTICAL_DATA 統計データの情報を出力します。
RESULT_INF 取得開始行、取得終了行、次回開始行の情報および統計データの件数を保持します。
TOTAL_NUMBER 絞込条件に一致する統計データの件数です。
TABLE_INF 指定した統計表又は指定したデータセットが指し示す統計データの情報を出力します。属性として統計表ID(id)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
CYCLE 統計表の提供周期です。
SURVEY_DATE 統計の調査年月です。
OPEN_DATE 統計表の公開日です。
SMALL_AREA 小地域属性のフラグです。
MAIN_CATEGORY 統計大分野名です。属性として統計大分野コード(code)を保持します。
SUB_CATEGORY 統計小分野名です。属性として統計小分野コード(code)を保持します。
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。
UPDATED_DATE 統計データの最終更新日です。
CLASS_INF 統計データのメタ情報を出力します。
リクエストパラメータのメタ情報有無(metaGetFlg)に”N”(取得しない)を指定した場合、このタグは出力されません。
CLASS_OBJ メタ情報の数分だけ出力します。属性としてメタ情報のID(id)、名称(name)及び解説(description)を保持します。解説はデータがある場合のみ出力されます。
CLASS メタ情報を構成する要素の数分だけ出力します。属性としてメタ情報要素のコード(code)、名称(name)、階層レベル(level)、単位(unit)、親コード(parentCode)及び追加情報(addInf)を保持します。単位、親コード及び追加情報はデータがある場合のみ出力されます。指定した絞り込み条件又はデータセットの条件又はその両方の条件によって抽出されるメタ情報のみ出力されます。

4.4.3. XML形式出力サンプル


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_STATS_DATA 
xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/<バージョン>/schema/GetStatsData.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2015-01-07T17:44:56.183+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <STATS_DATA_ID>0003090287</STATS_DATA_ID>
        <NARROWING_COND>
            <CODE_TAB_SELECT>006</CODE_TAB_SELECT>
        </NARROWING_COND>
        <DATA_FORMAT>X</DATA_FORMAT>
        <START_POSITION>1</START_POSITION>
        <LIMIT>100</LIMIT>
        <METAGET_FLG>Y</METAGET_FLG>
        <CNT_GET_FLG>N</CNT_GET_FLG>
    </PARAMETER>
    <STATISTICAL_DATA>
        <RESULT_INF>
            <TOTAL_NUMBER>1392</TOTAL_NUMBER>
            <FROM_NUMBER>1</FROM_NUMBER>
            <TO_NUMBER>100</TO_NUMBER>
            <NEXT_KEY>101</NEXT_KEY>
        </RESULT_INF>
        <TABLE_INF id="0003090287">
            <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME>
            <GOV_ORG code="00200">総務省</GOV_ORG>
            <STATISTICS_NAME>平成24年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏) 世帯単位で見た統計表</STATISTICS_NAME>
            <TITLE no="410101">世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県</TITLE>
            ・・・   
        </TABLE_INF>
        <CLASS_INF>
【表章事項】 <CLASS_OBJ id="tab" name="表章項目"> <CLASS code="006" name="世帯数" level="" unit="世帯"/> </CLASS_OBJ>
【分類事項01】 <CLASS_OBJ id="cat01" name="世帯家族類型,夫妻の就業状態・有業の親有無-2012"> <CLASS code="000" name="総数" level="1"/> <CLASS code="001" name="夫婦のみの世帯" level="2"/> <CLASS code="002" name="夫婦ともに有業" level="3"/> ・・・ </CLASS_OBJ>
【地域事項】 <CLASS_OBJ id="area" name="地域2012"> <CLASS code="00000" name="全国" level="1"/> <CLASS code="01000" name="北海道" level="2" parentCode="00000"/> ・・・ </CLASS_OBJ>
【時間軸事項】 <CLASS_OBJ id="time" name="時間軸(年次)"> <CLASS code="2012000000" name="2012年" level="1"/> </CLASS_OBJ>
</CLASS_INF> <DATA_INF> <NOTE char="*">平均値及び割合の算出に当たって除数が表章単位に満たないもの</NOTE> <NOTE char="-">該当数値のないもの,又は平均値及び割合の算出に当たって除数が0のもの</NOTE> <NOTE char="...">平均値及び割合の算出に当たって除数が表章単位に満たないもの,または増減率及び構成比の算出に当たって除数が1万人未満の場合</NOTE> <NOTE char="X">数字が秘匿されているもの</NOTE> <VALUE【表章事項】 tab="006"【分類事項01】 cat01="000"【地域事項】 area="00000"【時間軸事項】 time="2012000000" unit="世帯">28547900</VALUE> <VALUE【表章事項】 tab="006"【分類事項01】 cat01="000"【地域事項】 area="01000"【時間軸事項】 time="2012000000" unit="世帯">1289100</VALUE> <VALUE【表章事項】 tab="006"【分類事項01】 cat01="000"【地域事項】 area="02000"【時間軸事項】 time="2012000000" unit="世帯">278500</VALUE> <VALUE【表章事項】 tab="006"【分類事項01】 cat01="000"【地域事項】 area="03000"【時間軸事項】 time="2012000000" unit="世帯">263800</VALUE>

cntGetFlg=Y、metaGetFlg=Nを指定した場合(件数のみ取得し、メタ情報を取得しない)の出力は以下になります。


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_STATS_DATA
xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/<バージョン>/schema/GetStatsData.xsd" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2015-01-07T17:47:33.468+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <STATS_DATA_ID>0003090287</STATS_DATA_ID>
        <NARROWING_COND>
            <CODE_TAB_SELECT>006</CODE_TAB_SELECT>
        </NARROWING_COND>
        <DATA_FORMAT>X</DATA_FORMAT>
        <START_POSITION>1</START_POSITION>
        <LIMIT>100</LIMIT>
        <METAGET_FLG>N</METAGET_FLG>
        <CNT_GET_FLG>Y</CNT_GET_FLG>
    </PARAMETER>
    <STATISTICAL_DATA>
        <RESULT_INF>
            <TOTAL_NUMBER>1392</TOTAL_NUMBER>
        </RESULT_INF>
        <TABLE_INF id="0003090287">
            <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME>
            <GOV_ORG code="00200">総務省</GOV_ORG>
            <STATISTICS_NAME>平成24年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏) 世帯単位で見た統計表</STATISTICS_NAME>
            <TITLE no="410101">世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県</TITLE>
            ・・・   
        </TABLE_INF>
    </STATISTICAL_DATA>
</GET_STATS_DATA>

4.4.4. JSON形式出力サンプル


{
    "GET_STATS_DATA": {
        "RESULT": {
            "STATUS": 0,
            "ERROR_MSG": "正常に終了しました。",
            "DATE": "2015-01-07T17:48:48.640+09:00"
        },
        "PARAMETER": {
            "LANG": "J",
            "STATS_DATA_ID": "0003090287",
            "NARROWING_COND": {
                "CODE_TAB_SELECT": "006"
            },
            "DATA_FORMAT": "J",
            "START_POSITION": 1,
            "LIMIT": 100,
            "METAGET_FLG": "Y",
            "CNT_GET_FLG": "N"
        },
        "STATISTICAL_DATA": {
            "RESULT_INF": {
                "TOTAL_NUMBER": 1392,
                "FROM_NUMBER": 1,
                "TO_NUMBER": 100,
                "NEXT_KEY": 101
            },
            "TABLE_INF": {
                "@id": "0003090287",
                "STAT_NAME": {
                    "@code": "00200532",
                    "$": "就業構造基本調査"
                },
                "GOV_ORG": {
                    "@code": "00200",
                    "$": "総務省"
                },
                "STATISTICS_NAME": "平成24年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏) 世帯単位で見た統計表",
                "TITLE": {
                    "@no": "410101",
                    "$": "世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県"
                },
                ・・・
            },
            "CLASS_INF": {
                "CLASS_OBJ": [
                    {
                        "@id": "tab",
                        "@name": "表章項目",
                        "CLASS": {
                            "@code": "006",
                            "@name": "世帯数",
                            "@level": "",
                            "@unit": "世帯"
                        }
                    },
                    {
                        "@id": "cat01",
                        "@name": "世帯家族類型,夫妻の就業状態・有業の親有無-2012",
                        "CLASS": [
                            {
                                "@code": "000",
                                "@name": "総数",
                                "@level": "1"
                            },
                            ・・・
                        ]
                    },
                    ・・・
                ]
            },
            "DATA_INF": {
                "NOTE": [
                    {
                        "@char": "*",
                        "$": "平均値及び割合の算出に当たって除数が表章単位に満たないもの"
                    },
                    {
                        "@char": "-",
                        "$": "該当数値のないもの,又は平均値及び割合の算出に当たって除数が0のもの"
                    },
                    {
                        "@char": "...",
                        "$": "平均値及び割合の算出に当たって除数が表章単位に満たないもの,または増減率及び構成比の算出に当たって除数が1万人未満の場合"
                    },
                    {
                        "@char": "X",
                        "$": "数字が秘匿されているもの"
                    }
                ],
                "VALUE": [
                    {
                        "@tab": "006",
                        "@cat01": "000",
                        "@area": "00000",
                        "@time": "2012000000",
                        "@unit": "世帯",
                        "$": "28547900"
                    },
                    ・・・
                ]
            }
        }
    }
}

4.4.5. CSV形式出力サンプル

CSV形式出力は以下のフォーマットになります。

タグ名 内容
RESULT 固定文字列
STATUS APIの処理結果情報を出力します。以下の順番に出力されます。
タグ名、結果コード
結果コードが0 ~ 2の場合は正常終了、100 以上の場合はエラーです。
ERROR_MSG APIの処理結果をコードで表します。以下の順番に出力されます。
タグ名、メッセージ
DATE このCSVデータが出力された日時です。以下の順番に出力されます。
タグ名、出力日付
RESULT_INF 固定文字列
TOTAL_NUMBER 絞込条件に一致する統計データの件数です。以下の順番に出力されます。
タグ名、絞込後の件数
FROM_NUMBER データの開始位置です。以下の順番に出力されます。
タグ名、データの取得開始位置
TO_NUMBER データの終了位置です。以下の順番に出力されます。
タグ名、データの取得終了位置
NEXT_KEY 継続データ存在時の次のデータ開始位置です。以下の順番に出力されます。
タグ名、次データ開始位置
TABLE_INF タグ名、統計表ID
STAT_NAME 統計表の政府統計名です。以下の順番に出力されます。
タグ名、政府統計コード、政府統計名
GOV_ORG 統計表の作成機関名です。以下の順番に出力されます。
タグ名、作成機関コード、作成機関名
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。以下の順番に出力されます。
タグ名、提供統計名及び提供分類名
TITLE 統計表の提供周期です。以下の順番に出力されます。
タグ名、表番号, 表題
CYCLE 統計表の提供周期です。以下の順番に出力されます。
タグ名、提供周期
SURVEY_DATE 統計の調査年月です。以下の順番に出力されます。
タグ名、統計年月
OPEN_DATE 統計の公開日です。以下の順番に出力されます。
タグ名、公開日
SMALL_AREA 小地域属性のフラグです。以下の順番に出力されます。
タグ名、小地域フラグ
MAIN_CATEGORY 統計大分野名です。以下の順番に出力されます。
タグ名、統計大分野コード、統計大分野名
SUB_CATEGORY 統計小分野名です。以下の順番に出力されます。
タグ名、統計小分野コード、統計小分野名
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。以下の順番に出力されます。
タグ名、絞込条件なしでの総件数。
UPDATED_DATE 統計データの最終更新日です。以下の順番に出力されます。
タグ名、最終更新日付
STATISTICS_NAME_SPEC 統計表の提供統計名及び提供分類名の詳細です。以下の順番に出力されます。
タグ名、提供統計名、提供分類名1、提供分類名2、提供分類名3、提供分類名4、提供分類名5
※未設定の項目は、空文字が出力されます。
TITLE_SPEC 統計表の表題の詳細です。以下の順番に出力されます。
タグ名、表分類名、表名、表名区分1、表名区分2、表名区分3
※未設定の項目は、空文字が出力されます。
NOTE 特殊文字の凡例です。特殊文字の数分だけ出力されます。以下の順番に出力されます。
タグ名、特殊文字、説明
VALUE 固定文字列
統計数値表列タイトル 統計数値表の列タイトルです。1行だけ出力されます。以下の順番に出力されます。
tab_code、
表章事項の名称、
cat01_code、
分類事項01の名称、

cat15_code、
分類事項15の名称、
area_code、
地域事項の名称、
time_code、
時間軸事項の名称、
unit、
value

※tab、cat01~cat15、areaおよびtimeで始まるものは、データが存在する場合のみ出力されます。

統計数値表 統計数値(セル)の情報です。データ件数分だけ出力されます。以下の順番に出力されます。
表章事項要素コード、
表章事項要素名、
分類事項01要素コード、
分類事項01要素名、

分類事項15要素コード、
分類事項15要素名、
地域事項要素コード、
地域事項要素名、
時間軸事項要素コード、
時間軸事項要素名、
単位名、
統計数値

※表章事項要素、分類事項01~15要素、地域事項要素および時間軸要素は、データが存在する場合のみ出力されます。

RESULT、RESULT_INF、TABLE_INFおよびNOTEはsectionHeaderFlg=2の場合、出力されません。
以下の場合、RESULT情報のみが出力されます。
・結果コードが100以上の場合。
・結果コードが1で表示すべきデータがなく、sectionHeaderFlg=2の場合。

以下は出力例です。

【RESULT】"RESULT" "STATUS","0" "ERROR_MSG","正常に終了しました。" "DATE","2015-01-07T17:44:56.183+09:00"
【RESULT_INF】"RESULT_INF" "TOTAL_NUMBER","1392" "FROM_NUMBER","1" "TO_NUMBER","1000" "NEXT_KEY","1001"
【TABLE_INF】"TABLE_INF","0003090287" "STAT_NAME","00200532","就業構造基本調査" "GOV_ORG","00200","総務省" "STATISTICS_NAME","平成24年就業構造基本調査 地域別主要結果編(全国, …) …"   …
【NOTE】"NOTE","*","平均値及び割合の算出に当たって除数が表章単位に満たないもの" "NOTE","-","該当数値のないもの,又は平均値及び割合の算出に当たって除数が0のもの"  …
【VALUE】 "VALUE" "tab_code","表章項目","cat01_code","世帯家族類型,夫妻の就業状態・有業の親有無-2012","area_code","地域2012","unit","value" "006","世帯数","01","夫婦のみの世帯","01000","北海道","世帯","1289100" "006","世帯数","01","夫婦のみの世帯","02000","青森県","世帯","113610"  …

4.5. データセット登録

ルートタグは<POST_DATASET>です。

4.5.1. PARAMETER タグ

リクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別のAPIのパラメータを指定した場合は出力されません。

タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATASET_ID データセットID
DATASET_NAME データセット名
STATS_DATA_ID 統計表ID
NARROWING_COND 絞り込み条件
LEVEL_TAB_COND 表章事項のレベル指定
CODE_TAB_SELECT 表章事項の単一コード指定
CODE_TAB_FROM 表章事項のコードの範囲(開始)指定
CODE_TAB_TO 表章事項のコードの範囲(終了)指定
LEVEL_TIME_COND 時間軸事項のレベル指定
CODE_TIME_SELECT 時間軸事項の単一コード指定
CODE_TIME_FROM 時間軸事項のコードの範囲(開始)指定
CODE_TIME_TO 時間軸事項のコードの範囲(終了)指定
LEVEL_AREA_COND 地域事項のレベル指定
CODE_AREA_SELECT 地域事項の単一コード指定
CODE_AREA_FROM 地域事項のコードの範囲(開始)指定
CODE_AREA_TO 地域事項のコードの範囲(終了)指定
LEVEL_CAT01_COND 分類事項01のレベル指定
CODE_CAT01_SELECT 分類事項01の単一コード指定
CODE_CAT01_FROM 分類事項01のコードの範囲(開始)指定
CODE_CAT01_TO 分類事項01のコードの範囲(終了)指定
・・・ ※ 分類事項は 01 から 15 まで
OPEN_SPECIFIED 公開可否
PROCESS_MODE 処理モード

4.5.2. REGIST_INF タグ

登録又は削除したデータセットの情報を出力します。エラーがあった場合はこのタグ自体出力されません。

タグ名 内容
REGIST_INF 登録又は削除したデータセットの情報を出力します。属性として処理モード(mode) を保持します。(処理モードは “add”、”update”、”delete” のいずれか)
DATASET_ID データセットのデータセットIDです。
STATS_DATA_ID データセットが指定する統計表IDです。
PUBLIC_STATE データセットの公開可否状態です。
TOTAL_NUMBER データセットの条件で出力される統計データの件数です。

4.5.3. 出力サンプル


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<POST_DATASET
xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/<バージョン>/schema/PostDataSet.xsd
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">	
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2015-01-07T18:04:06.903+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <STATS_DATA_ID>0003010900</STATS_DATA_ID>
        <DATASET_NAME>住宅・土地統計調査 データセット1</DATASET_NAME>
        <NARROWING_COND>
            <CODE_CAT01_FROM>01</CODE_CAT01_FROM>
            <CODE_CAT01_TO>02</CODE_CAT01_TO>
            <CODE_CAT02_SELECT>03</CODE_CAT02_SELECT>
            <LEVEL_AREA_COND>1</LEVEL_AREA_COND>
        </NARROWING_COND>
        <OPEN_SPECIFIED>1</OPEN_SPECIFIED>
        <PROCESS_MODE>E</PROCESS_MODE>
    </PARAMETER>
    <REGIST_INF mode="add">
        <DATASET_ID>00200522-20150107180406</DATASET_ID>
        <STATS_DATA_ID>0003010900</STATS_DATA_ID>
        <PUBLIC_STATE>yes</PUBLIC_STATE>
        <TOTAL_NUMBER>2</TOTAL_NUMBER>
    </REGIST_INF>
</POST_DATASET>

4.6. データセット参照

パラメータのデータセットIDを指定しない場合、以下のように複数のデータセット情報が一覧として出力されます。ルートタグは<GET_DATASET_LIST>になります。


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<GET_DATASET__LIST
  xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/<バージョン>/schema/GetDataSetList.xsd"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
    ・・・
    </RESULT>
    <PARAMETER>
    ・・・
    </PARAMETER>
    <DATASET_LIST_INF>
      <NUMBER>2</NUMBER>
<DATASET_INF></DATASET_INF> 件数分出力 <DATASET_INF></DATASET_INF>
<DATASET_LIST_INF> </GET_STATS_LIST>

パラメータのデータセットIDを指定した場合、以下のようにデータセット情報が1件出力されます。

ルートタグは< REF_DATASET >になります。


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<REF_DATASET
  xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/<バージョン>/schema/RefDataSet.xsd"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
    ・・・
    </RESULT>
    <PARAMETER>
    ・・・
    </PARAMETER>
<DATASET_INF> … パラメータで指定したデータセット情報を出力 </DATASET_INF>
</REF_DATASET>

4.6.1. PARAMETER タグ

リクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別のAPIのパラメータを指定した場合は出力されません。

タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATASET_ID データセットID(データセットIDを指定した場合のみ)
DATA_FORMAT 出力フォーマット形式
「X」:XML形式
「J」:JSON形式又はJSONP形式
CALLBACK コールバック関数

4.6.2. DATASET_LIST_INF タグ

利用者が参照・使用できるデータセットの一覧を出力します。エラーがあった場合、このタグ自体出力されません。

タグ名 内容
DATASET_LIST_INF データセット一覧を出力します。
NUMBER 一覧に出力されるデータセットの件数です。
DATASET_INF データセットの情報をNUMBERの件数分出力します。属性としてデータセットID(id) を保持します。
DATASET_NAME データセット名です。
PUBLIC_STATE データセットの公開可否状態です。
RESULT_INF 統計データの件数を保持します。
TOTAL_NUMBER データセットの絞込条件による統計データ件数を出力します。
TABLE_INF データセットが参照する統計表の情報を出力します。属性として統計表ID(id)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
CYCLE 統計表の提供周期です。
SURVEY_DATE 統計の調査年月です。
OPEN_DATE 統計表の公開日です。
SMALL_AREA 小地域属性のフラグです。
MAIN_CATEGORY 統計大分野名です。属性として統計大分野コード(code)を保持します。
SUB_CATEGORY 統計小分野名です。属性として統計小分野コード(code)を保持します。
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。
UPDATED_DATE 統計データの最終更新日です。

4.6.3. XML形式出力サンプル(GET_DATASET_LIST)


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_DATASET_LIST
xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/<バージョン>/schema/GetDataSetList.xsd
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2015-01-07T18:14:29.055+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <DATA_FORMAT>X</DATA_FORMAT>
    </PARAMETER>
    <DATASET_LIST_INF>
        <NUMBER>13</NUMBER>
        <DATASET_INF id="00200522-20150107180406">
            <DATASET_NAME>住宅・土地統計調査 データセット1</DATASET_NAME>
            <PUBLIC_STATE>YES</PUBLIC_STATE>
            <RESULT_INF>
                <TOTAL_NUMBER>2</TOTAL_NUMBER>
            </RESULT_INF>
            <TABLE_INF id="0003010900">
                <STAT_NAME code="00200522">住宅・土地統計調査</STAT_NAME>
                <GOV_ORG code="00200">総務省</GOV_ORG>
                <STATISTICS_NAME>平成20年住宅・土地統計調査 全国編</STATISTICS_NAME>
                <TITLE no="001-2">居住世帯の有無(9区分)別住宅数及び建物の種類(4区分)別住宅以外で人が居住する建物数―全国,人口集中地区</TITLE>
                <CYCLE>-</CYCLE>
                <SURVEY_DATE>200810</SURVEY_DATE>
                <OPEN_DATE>2010-03-30</OPEN_DATE>
                <SMALL_AREA>0</SMALL_AREA>
                <MAIN_CATEGORY code="08">住宅・土地・建設</MAIN_CATEGORY>
                <SUB_CATEGORY code="01">住宅・土地</SUB_CATEGORY>
                <OVERALL_TOTAL_NUMBER>250</OVERALL_TOTAL_NUMBER>
                <UPDATED_DATE>2010-03-30</UPDATED_DATE>
            </TABLE_INF>
        </DATASET_INF>
        ・・・
    </DATASET_LIST_INF>
</GET_DATASET_LIST>


※JSON形式のデータも、XML形式のデータを元に変換されるため、同様の情報が出力されます。

4.6.4. 出力サンプル

パラメータで指定したデータセットの情報を出力します。エラーがあった場合、このタグ自体出力されません。

タグ名 内容
DATASET_INF データセットの情報を出力します。属性としてデータセットID(id)を保持します。
DATASET_NAME データセット名です。
NARROWING_COND 対象のデータセットで指定されている絞り込み条件です。
LEVEL_TAB_COND 表章事項のレベル指定
CODE_TAB_SELECT 表章事項の単一コード指定
CODE_TAB_FROM 表章事項のコードの範囲(開始)指定
CODE_TAB_TO 表章事項のコードの範囲(終了)指定
LEVEL_TIME_COND 時間軸事項のレベル指定
CODE_TIME_SELECT 時間軸事項の単一コード指定
CODE_TIME_FROM 時間軸事項のコードの範囲(開始)指定
CODE_TIME_TO 時間軸事項のコードの範囲(終了)指定
LEVEL_AREA_COND 地域事項のレベル指定
CODE_AREA_SELECT 地域事項の単一コード指定
CODE_AREA_FROM 地域事項のコードの範囲(開始)指定
CODE_AREA_TO 地域事項のコードの範囲(終了)指定
LEVEL_CAT01_COND 分類事項01のレベル指定
CODE_CAT01_SELECT 分類事項01の単一コード指定
CODE_CAT01_FROM 分類事項01のコードの範囲(開始)指定
CODE_CAT01_TO 分類事項01のコードの範囲(終了)指定
・・・ ※ 分類事項は 01 から 15 まで
PUBLIC_STATE データセットの公開可否状態です。
RESULT_INF 統計データの件数を保持します。
TOTAL_NUMBER データセットの絞込条件による統計データ件数を出力します。
TABLE_INF データセットが参照する統計表の情報を出力します。属性として統計表ID(id)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
CYCLE 統計表の提供周期です。
SURVEY_DATE 統計の調査年月です。
OPEN_DATE 統計表の公開日です。
SMALL_AREA 小地域属性のフラグです。
MAIN_CATEGORY 統計大分野名です。属性として統計大分野コード(code)を保持します。
SUB_CATEGORY 統計小分野名です。属性として統計小分野コード(code)を保持します。
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。
UPDATED_DATE 統計データの最終更新日です。

4.6.5. XML形式出力サンプル(REF_DATASET)


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<REF_DATASET
xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/<バージョン>/schema/RefDataSet.xsd
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2015-01-07T22:27:35.919+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <DATASET_ID>00200522-20150107180406</DATASET_ID>
        <DATA_FORMAT>X</DATA_FORMAT>
    </PARAMETER>
    <DATASET_INF id="00200522-20150107180406">
        <DATASET_NAME>住宅・土地統計調査 データセット1</DATASET_NAME>
        <NARROWING_COND>
            <CODE_CAT01_FROM>01</CODE_CAT01_FROM>
            <CODE_CAT01_TO>02</CODE_CAT01_TO>
            <CODE_CAT02_SELECT>03</CODE_CAT02_SELECT>
            <LEVEL_AREA_COND>1</LEVEL_AREA_COND>
        </NARROWING_COND>
        <PUBLIC_STATE>YES</PUBLIC_STATE>
        <RESULT_INF>
            <TOTAL_NUMBER>2</TOTAL_NUMBER>
        </RESULT_INF>
        <TABLE_INF id="0003010900">
            <STAT_NAME code="00200522">住宅・土地統計調査</STAT_NAME>
            <GOV_ORG code="00200">総務省</GOV_ORG>
            <STATISTICS_NAME>平成20年住宅・土地統計調査 全国編</STATISTICS_NAME>
            <TITLE no="001-2">居住世帯の有無(9区分)別住宅数及び建物の種類(4区分)別住宅以外で人が居住する建物数―全国,人口集中地区</TITLE>
            <CYCLE>-</CYCLE>
            <SURVEY_DATE>200810</SURVEY_DATE>
            <OPEN_DATE>2010-03-30</OPEN_DATE>
            <SMALL_AREA>0</SMALL_AREA>
            <MAIN_CATEGORY code="08">住宅・土地・建設</MAIN_CATEGORY>
            <SUB_CATEGORY code="01">住宅・土地</SUB_CATEGORY>
            <OVERALL_TOTAL_NUMBER>250</OVERALL_TOTAL_NUMBER>
            <UPDATED_DATE>2010-03-30</UPDATED_DATE>
        </TABLE_INF>
    </DATASET_INF>
</REF_DATASET>


※JSON形式のデータも、XML形式のデータを元に変換されるため、同様の情報が出力されます。

4.7. データカタログ情報取得

ルートタグは<GET_DATA_CATALOG>です。

4.7.1. PARAMETER タグ

リクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別のAPIのパラメータを指定した場合は出力されません。

タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATA_FORMAT 出力フォーマット形式
「X」:XML形式
「J」:JSON形式又はJSONP形式
SURVEY_YEARS 調査年月
OPEN_YEARS 公開年月
STATS_FIELD 統計分野
STATS_CODE 政府統計コード
SEARCH_WORD 検索キーワード
DATA_TYPE 検索データ形式
CATALOG_ID カタログID
RESOURCE_ID カタログリソースID
START_POSITION データセット取得開始位置
LIMIT データセット取得件数
UPDATED_DATE 更新日付
CALLBACK コールバック関数

4.7.2. DATA_CATALOG_LIST_INF タグ

データカタログ情報を出力します。エラーがあった場合はこのタグ自体出力されません。

タグ名 内容
DATA_CATALOG_LIST_INF データカタログ情報を出力します。
NUMBER 検索条件に一致するカタログデータセットの件数です。
RESULT_INF 取得開始カタログデータセット位置、取得終了カタログデータセット位置および次回開始カタログデータセット位置の情報を保持します。
FROM_NUMBER カタログデータセットの開始位置です。
TO_NUMBER カタログデータセットの終了位置です。
NEXT_KEY 継続データ存在時の次のカタログデータセット開始位置です。
DATA_CATALOG_INF 1つのカタログデータセット情報とそのカタログデータセットに属するカタログデータリソース情報を保持します。属性にカタログID(id)を保持します。検索に一致するカタログデータ数分出力されます。
DATASET カタログデータセット情報を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
ORGANIZATION 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
TITLE カタログデータセットの名称情報を保持します。
NAME カタログデータセット名を保持します。
TABULATION_CATEGORY 統計表の提供統計名を保持します。
TABULATION_SUB_CATEGORY1 統計表提供分類名1を保持します。
TABULATION_SUB_CATEGORY2 統計表提供分類名2を保持します。
TABULATION_SUB_CATEGORY3 統計表提供分類名3を保持します。
TABULATION_SUB_CATEGORY4 統計表提供分類名4を保持します。
TABULATION_SUB_CATEGORY5 統計表提供分類名5を保持します。
CYCLE 提供周期名を保持します。
SURVEY_DATE 調査実施時期を保持します。
DESCRIPTION カタログデータセットの解説を保持します。
PUBLISHER 統計表の公表組織名を保持します。
CONTACT_POINT 統計表の作成機関への連絡先を保持します。
CREATOR 統計表の作成者名を保持します。
RELEASE_DATE カタログデータセットの公表日を保持します。
LAST_MODIFIED_DATE カタログデータセットの最終更新日を保持します。
FREQUENCY_OF_UPDATE カタログデータセットの提供周期を保持します。
LANDING_PAGE カタログデータセットが公開されている政府統計の総合窓口(e-Stat)でのURLを保持します。
統計種別が統計データベースの場合、空文字列を保持します。
RESOURCES カタログデータセットに属するカタログデータリソース(統計表ファイルおよび統計データベース)の情報を保持します。
RESOURCE 1つのカタログデータリソース統計表ファイルの情報を保持します。属性にカタログデータリソースID(id)を保持します。カタログデータリソース分出力されます。
TITLE カタログデータリソースの名称情報を出力します。
NAME カタログデータリソース名を保持します。
TABLE_CATEGORY 表分類名を保持します。
TABLE_NO 表番号を保持します。
TABLE_NAME 表名を保持します。
TABLE_SUB_CATEGORY1 表名区分1を保持します。
TABLE_SUB_CATEGORY2 表名区分2を保持します。
TABLE_SUB_CATEGORY3 表名区分3を保持します。
URL カタログデータリソースをダウンロードする政府統計の総合窓口(e-Stat)でのURLを保持します。
統計種別が統計データベースの場合、統計表IDを保持します。
DESCRIPTION カタログデータリソースの解説を保持します。
FORMAT カタログデータリソースのデータ形式を保持します。
“XLS”:エクセルファイル
“CSV”:CSVファイル
“PDF”:PDFファイル
“DB”:統計データベース
RELEASE_DATE カタログデータリソースの公表日を保持します。
LAST_MODIFIED_DATE カタログデータリソースの最終更新日を保持します。
RESOURCE_LICENCE_ID カタログデータリソースのライセンス情報を保持します。
LANGUAGE カタログデータリソースの記述言語情報を保持します。

4.7.3. XML形式出力サンプル


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_DATA_CATALOG
 xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/<バージョン>/schema/GetDataCatalog.xsd
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2014-10-17T11:42:44.104+09:00</DATE>
    </RESULT>
    <PARAMETER>
        <LANG>J</LANG>
        <DATA_TYPE>XLS</DATA_TYPE>
        <DATA_FORMAT>X</ DATA_FORMAT>
        <LIMIT>100</LIMIT>
    </PARAMETER>
    <DATA_CATALOG_LIST_INF>
        <NUMBER>452</NUMBER>
        <RESULT_INF>
            <FROM_NUMBER>1</FROM_NUMBER>
            <TO_NUMBER>100</TO_NUMBER>
            <NEXT_KEY>101</NEXT_KEY>
        </RESULT_INF>
        <DATA_CATALOG_INF id="000001012779">
            <DATASET>
                <STAT_NAME code="00020111">民間企業の勤務条件制度等調査</STAT_NAME>
                <ORGANIZATION code="00020">人事院</ORGANIZATION>
                <TITLE>
                    <NAME>平成20年民間企業の勤務条件制度等調査_統計表_年次_2008年</NAME>
                    <TABULATION_CATEGORY>平成20年民間企業の勤務条件制度等調査</TABULATION_CATEGORY>
                    <TABULATION_SUB_CATEGORY1>統計表</TABULATION_SUB_CATEGORY1>
                    <TABULATION_SUB_CATEGORY2></TABULATION_SUB_CATEGORY2>
                    <TABULATION_SUB_CATEGORY3></TABULATION_SUB_CATEGORY3>
                    <TABULATION_SUB_CATEGORY4></TABULATION_SUB_CATEGORY4>
                    <TABULATION_SUB_CATEGORY5></TABULATION_SUB_CATEGORY5>
                    <CYCLE>年次</CYCLE>
                    <SURVEY_DATE>2008年</SURVEY_DATE>
                </TITLE>
                <DESCRIPTION></DESCRIPTION>
                <PUBLISHER>人事院</PUBLISHER>
                <CONTACT_POINT></CONTACT_POINT>
                <CREATOR></CREATOR>
                <RELEASE_DATE>2012-11-01</RELEASE_DATE>
                <LAST_MODIFIED_DATE>2012-11-24</LAST_MODIFIED_DATE>
                <FREQUENCY_OF_UPDATE>年次</FREQUENCY_OF_UPDATE>
                <LANDING_PAGE>
                  http://www.e-stat.go.jp/SG1/estat/GL08020103.do?_toGL08020103_&tclassID=…
                </LANDING_PAGE>
            </DATASET>
            <RESOURCES>
                <RESOURCE id="000001082529">
                    <TITLE>
                        <NAME>1_時間外労働の命令方法別企業数割合(母集団:時間外労働に…</NAME>
                        <TABLE_CATEGORY></TABLE_CATEGORY>
                        <TABLE_NO>1</TABLE_NO>
                        <TABLE_NAME>時間外労働の命令方法別企業数割合(…</TABLE_NAME>
                        <TABLE_SUB_CATEGORY1></TABLE_SUB_CATEGORY1>
                        <TABLE_SUB_CATEGORY2></TABLE_SUB_CATEGORY2>
                        <TABLE_SUB_CATEGORY3></TABLE_SUB_CATEGORY3>
                    </TITLE>
                    <URL>
                      http://www.e-stat.go.jp/SG1/estat/GL08020103.do?_csvDownload_&fileId=…
                    </URL>
                    <DESCRIPTION></DESCRIPTION>
                    <FORMAT>XLS</FORMAT>
                    <RELEASE_DATE>2012-11-01</RELEASE_DATE>
                    <LAST_MODIFIED_DATE>2012-11-24</LAST_MODIFIED_DATE>
                    <RESOURCE_LICENCE_ID></RESOURCE_LICENCE_ID>
                    <LANGUAGE>J</LANGUAGE>
                </RESOURCE>
            </RESOURCES>
                ・・・
        </DATA_CATALOG_INF>
        ・・・
    </DATA_CATALOG_LIST_INF>
</GET_DATA_CATALOG>

4.7.4. JSON形式出力サンプル


{
  "GET_DATA_CATALOG": {
    "RESULT": {
      "STATUS": 0,
      "ERROR_MSG": "正常に終了しました。",
      "DATE": "2014-12-24T14:28:44.359+09:00"
    },
    "PARAMETER": {
      "LANG": "J",
      "SEARCH_KIND": 0,
      "DATA_FORMAT": "J",
      "LIMIT": 100
    },
    "DATA_CATALOG_LIST_INF": {
      "NUMBER": 452,
      "RESULT_INF": {
        "FROM_NUMBER": 1,
        "TO_NUMBER": 100,
        "NEXT_KEY": 101
      },
      "DATA_CATALOG_INF": [
        {
          "@id": "000001012779",
          "DATASET": {
            "STAT_NAME": {
              "@code": "00020111",
              "$": "民間企業の勤務条件制度等調査"
            },
            "ORGANIZATION": {
              "@code": "00020",
              "$": "人事院"
            },
            "TITLE": {
              "NAME": "平成20年民間企業の勤務条件制度等調査_統計表_年次_2008年",
              "TABULATION_CATEGORY": "平成20年民間企業の勤務条件制度等調査",
              "TABULATION_SUB_CATEGORY1": "統計表",
              "TABULATION_SUB_CATEGORY2": "",
              "TABULATION_SUB_CATEGORY3": "",
              "TABULATION_SUB_CATEGORY4": "",
              "TABULATION_SUB_CATEGORY5": "",
              "CYCLE": "年次",
              "SURVEY_DATE": "2008年"
            },
            "DESCRIPTION": "",
            "PUBLISHER": "人事院",
            "CONTACT_POINT": "",
            "CREATOR": "",
            "RELEASE_DATE": "2012-11-01",
            "LAST_MODIFIED_DATE": "2012-11-24",
            "FREQUENCY_OF_UPDATE": "年次",
            "LANDING_PAGE": "http://www.e-stat.go.jp/SG1/estat/GL08020103.do?_toGL08020103_…"
          },
          "RESOURCES": {
            "RESOURCE": [
              {
                "@id": "000001082529",
                "TITLE": {
                  "NAME": "1_時間外労働の命令方法別企業数割合(母集団:時間外労働に…",
                  "TABLE_CATEGORY": "",
                  "TABLE_NO": 1,
                  "TABLE_NAME": "時間外労働の命令方法別企業数割合(母集団:時間外労働に…",
                  "TABLE_SUB_CATEGORY1": "",
                  "TABLE_SUB_CATEGORY2": "",
                  "TABLE_SUB_CATEGORY3": ""
                },
                "URL": "http://www.e-stat.go.jp/SG1/estat/GL08020103.do?_csvDownload_…",
                "DESCRIPTION": "",
                "FORMAT": "XLS",
                "RELEASE_DATE": "2012-11-01",
                "LAST_MODIFIED_DATE": "2012-11-24",
                "RESOURCE_LICENCE_ID": "",
                "LANGUAGE": "J"
                },
                ・・・(RESOURCEの繰り返し)
            ]
          }
        },
        ・・・ (DATA_CATALOG_INFの繰り返し)
      ]
    }
  }
}

4.8. 統計データ一括取得

統計データ一括取得では1つの返却データに複数の取得結果が含まれます。ルートタグは<GET_STATS_DATAS>になります。


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<GET_STATS_DATAS
  xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/<バージョン>/schema/GetStatsDatas.xsd"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
    ・・・
    </RESULT>
<PARAMETER_LIST> <PARAMETER_INF requestNo=1> ・・・ </PARAMETER_INF> ・・・ </PARAMETER_LIST>
4.8. 統計データ一括取得
リクエストしたパラメータ群の一覧がリクエスト単位で出力されます。
リクエスト番号(requestNo)で出力結果の関連付けを行います。
<STATISTICAL_DATA_LIST> <RESULT_INF> </RESULT_INF>
<TABLE_INF_LIST> <TABLE_INF requestNo=1> ・・・ </TABLE_INF> ・・・ </TABLE_INF_LIST>
4.8. 統計データ一括取得
リクエストした結果の統計表情報がリクエスト単位で出力されます。
<CLASS_INF_LIST> <CLASS_INF requestNo=1> ・・・ </CLASS_INF> ・・・ </CLASS_INF_LIST>
4.8. 統計データ一括取得
リクエストした結果のメタ情報がリクエスト単位で出力されます。
<DATA_INF_LIST> <DATA_INF requestNo=1> ・・・ </DATA_INF> ・・・ </DATA_INF_LIST>
4.8. 統計データ一括取得
リクエストした結果の統計データ情報がリクエスト単位で出力されます。
</STATISTICAL_DATA_LIST> </GET_STATS_DATAS>

4.8.1. PARAMETER__LISTタグ

リクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別のAPIのパラメータを指定した場合は出力されません

タグ名 内容
PARAMETER_LIST リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATA_FORMAT データフォーマット
「X」:XML形式
「J」:JSON形式又はJSONP形式
「C」:CSV形式
META_GET_FLG メタ情報出力有無
PARAMETER リクエストのパラメータ。リクエスト数分出力します。属性としてリクエスト番号(requestNo)を保持します。
DATASET_ID データセットID
STATS_DATA_ID 統計表ID
NARROWING_COND 絞り込み条件
LEVEL_TAB_COND 表章事項のレベル指定
CODE_TAB_SELECT 表章事項の単一コード指定
CODE_TAB_FROM 表章事項のコードの範囲(開始)指定
CODE_TAB_TO 表章事項のコードの範囲(終了)指定
LEVEL_TIME_COND 時間軸事項のレベル指定
CODE_TIME_SELECT 時間軸事項の単一コード指定
CODE_TIME_FROM 時間軸事項のコードの範囲(開始)指定
CODE_TIME_TO 時間軸事項のコードの範囲(終了)指定
LEVEL_AREA_COND 地域事項のレベル指定
CODE_AREA_SELECT 地域事項の単一コード指定
CODE_AREA_FROM 地域事項のコードの範囲(開始)指定
CODE_AREA_TO 地域事項のコードの範囲(終了)指定
LEVEL_CAT01_COND 分類事項01のレベル指定
CODE_CAT01_SELECT 分類事項01の単一コード指定
CODE_CAT01_FROM 分類事項01のコードの範囲(開始)指定
CODE_CAT01_TO 分類事項01のコードの範囲(終了)指定
・・・ ※ 分類事項は 01 から 15 まで
START_POSITION データ出力開始位置
LIMIT 取得データ件数

4.8.2. STATISTICAL_DATA_LIST タグ

統計データの情報を出力します。エラーがあった場合はこのタグ自体出力されません。

タグ名 内容
STATISTICAL_DATA_LIST 統計データの情報を出力します。
RESULT_INF 取得開始行、取得終了行、次回開始行の情報および統計データの件数を保持します。
TOTAL_NUMBER 全リクエストの絞込条件に一致する統計データの総件数です。
TABLE_INF_LIST 統計表情報のリスト。
TABLE_INF 指定した統計表又は指定したデータセットが指し示す統計データの情報を出力します。リクエスト数分出力します。属性として統計表ID(id)およびリクエスト番号(requestNo)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
CYCLE 統計表の提供周期です。
SURVEY_DATE 統計の調査年月です。
OPEN_DATE 統計表の公開日です。
SMALL_AREA 小地域属性のフラグです。
MAIN_CATEGORY 統計大分野名です。属性として統計大分野コード(code)を保持します。
SUB_CATEGORY 統計小分野名です。属性として統計小分野コード(code)を保持します。
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。
UPDATED_DATE 統計データの最終更新日です。
STATISTICS_NAME_SPEC 統計表の提供統計名及び提供分類名の詳細です。
TABULATION_CATEGORY 統計表の提供統計名を保持します。
TABULATION_SUB_CATEGORY1 統計表提供分類名1を保持します。
TABULATION_SUB_CATEGORY2 統計表提供分類名2を保持します。
TABULATION_SUB_CATEGORY3 統計表提供分類名3を保持します。
TABULATION_SUB_CATEGORY4 統計表提供分類名4を保持します。
TABULATION_SUB_CATEGORY5 統計表提供分類名5を保持します。
TITLE_SPEC 統計表の表題の詳細です。
TABLE_CATEGORY 表分類名を保持します。
TABLE_NAME 表名を保持します。
TABLE_SUB_CATEGORY1 表名区分1を保持します。
TABLE_SUB_CATEGORY2 表名区分2を保持します。
TABLE_SUB_CATEGORY3 表名区分3を保持します。
CLASS_INF_LIST メタ情報のリスト。
CLASS_INF 統計データのメタ情報を出力します。リクエスト数分出力します。属性としてリクエスト番号(requestNo)を保持します。
リクエストパラメータのメタ情報有無(metaGetFlg)に”N”(取得しない)を指定した場合、このタグは出力されません。
CLASS_OBJ メタ情報の数分だけ出力します。属性としてメタ情報のID(id)、名称(name)及び解説(description)を保持します。解説はデータがある場合のみ出力されます。
CLASS メタ情報を構成する要素の数分だけ出力します。属性としてメタ情報要素のコード(code)、名称(name)、階層レベル(level)、単位(unit)、親コード(parentCode)及び追加情報(addInf)を保持します。単位、親コード及び追加情報はデータがある場合のみ出力されます。指定した絞り込み条件又はデータセットの条件又はその両方の条件によって抽出されるメタ情報のみ出力されます。
DATA_INF_LIST 数値情報のリスト。
DATA_INF 統計データの数値情報を出力します。リクエスト数分出力します。
属性としてリクエスト番号(requestNo)を保持します。
指定した絞り込み条件又はデータセットの条件又はその両方の条件によって抽出されるデータ件数が 0 の場合、このタグは出力されません。
NOTE 特殊文字の凡例です。特殊文字の数分だけ出力されます。
属性として特殊文字(char)を保持します。
VALUE 統計数値(セル)の情報です。データ件数分だけ出力されます。
属性として表章事項コード(tab)、分類事項コード(cat01 ~ cat15)、地域事項コード(area)、時間軸事項コード(time)、単位(unit)を保持します。全ての属性はデータがある場合のみ出力されます。

4.8.3. XML形式出力サンプル


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_STATS_DATAS xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/<バージョン>/schema/GetStatsDatas.xsd
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RESULT>
        <STATUS>0</STATUS>
        <ERROR_MSG>正常に終了しました。</ERROR_MSG>
        <DATE>2016-03-30T16:58:06.492+09:00</DATE>
    </RESULT>
    <PARAMETER_LIST>
        <LANG>J</LANG>
        <DATA_FORMAT>X</DATA_FORMAT>
        <META_GET_FLG>Y</META_GET_FLG>
        <PARAMETER requestNo="1">
            <STATS_DATA_ID>0003090287</STATS_DATA_ID>
            <START_POSITION>1</START_POSITION>
            <LIMIT>10</LIMIT>
        </PARAMETER>
        <PARAMETER requestNo="2">
            <STATS_DATA_ID>0003010900</STATS_DATA_ID>
            <START_POSITION>1</START_POSITION>
            <LIMIT>10</LIMIT>
        </PARAMETER>
    </PARAMETER_LIST>
    <STATISTICAL_DATA_LIST>
        <RESULT_INF>
            <TOTAL_NUMBER>1642</TOTAL_NUMBER>
        </RESULT_INF>
        <TABLE_INF_LIST>
            <TABLE_INF id="0003090287" requestNo="1">
                <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME>
                <GOV_ORG code="00200">総務省</GOV_ORG>
                <STATISTICS_NAME>平成24年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏) 世帯単位で見た統計表</STATISTICS_NAME>
                <TITLE no="410101">世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県</TITLE>
                <CYCLE>-</CYCLE>
                <SURVEY_DATE>201210</SURVEY_DATE>
                <OPEN_DATE>2014-03-20</OPEN_DATE>
                <SMALL_AREA>0</SMALL_AREA>
                <MAIN_CATEGORY code="03">労働・賃金</MAIN_CATEGORY>
                <SUB_CATEGORY code="01">労働力</SUB_CATEGORY>
                <OVERALL_TOTAL_NUMBER>1392</OVERALL_TOTAL_NUMBER>
                <UPDATED_DATE>2014-03-19</UPDATED_DATE>
                <STATISTICS_NAME_SPEC>
                    <TABULATION_CATEGORY>平成24年就業構造基本調査</TABULATION_CATEGORY>
                    <TABULATION_SUB_CATEGORY1>地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏)</TABULATION_SUB_CATEGORY1>
                    <TABULATION_SUB_CATEGORY2>世帯単位で見た統計表</TABULATION_SUB_CATEGORY2>
                </STATISTICS_NAME_SPEC>
                <TITLE_SPEC>
                    <TABLE_NAME>世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県</TABLE_NAME>
                </TITLE_SPEC>
            </TABLE_INF>
            <TABLE_INF id="0003010900" requestNo="2">
                <STAT_NAME code="00200522">住宅・土地統計調査</STAT_NAME>
                <GOV_ORG code="00200">総務省</GOV_ORG>
                <STATISTICS_NAME>平成20年住宅・土地統計調査 全国編</STATISTICS_NAME>
                <TITLE no="001-2">居住世帯の有無(9区分)別住宅数及び建物の種類(4区分)別住宅以外で人が居住する建物数―全国,人口集中地区</TITLE>
                <CYCLE>-</CYCLE>
                <SURVEY_DATE>200810</SURVEY_DATE>
                <OPEN_DATE>2010-03-30</OPEN_DATE>
                <SMALL_AREA>0</SMALL_AREA>
                <MAIN_CATEGORY code="08">住宅・土地・建設</MAIN_CATEGORY>
                <SUB_CATEGORY code="01">住宅・土地</SUB_CATEGORY>
                <OVERALL_TOTAL_NUMBER>250</OVERALL_TOTAL_NUMBER>
                <UPDATED_DATE>2010-03-30</UPDATED_DATE>
                <STATISTICS_NAME_SPEC>
                    <TABULATION_CATEGORY>平成20年住宅・土地統計調査</TABULATION_CATEGORY>
                    <TABULATION_SUB_CATEGORY1>全国編</TABULATION_SUB_CATEGORY1>
                </STATISTICS_NAME_SPEC>
                <TITLE_SPEC>
                    <TABLE_NAME>居住世帯の有無(9区分)別住宅数及び建物の種類(4区分)別住宅以外で人が居住する建物数―全国,人口集中地区</TABLE_NAME>
                </TITLE_SPEC>
            </TABLE_INF>
        </TABLE_INF_LIST>
        <CLASS_INF_LIST>
            <CLASS_INF requestNo="1">
                <CLASS_OBJ id="tab" name="表章項目">
                    <CLASS code="006" name="世帯数" level="" unit="世帯"/>
                </CLASS_OBJ>
                <CLASS_OBJ id="cat01" name="世帯家族類型,夫妻の就業状態・有業の親有無-2012">
                    <CLASS code="000" name="総数" level="1"/>
                    <CLASS code="001" name="夫婦のみの世帯" level="2"/>
                    <CLASS code="002" name="夫婦ともに有業" level="3"/>
                    …
                </CLASS_OBJ>
                <CLASS_OBJ id="area" name="地域2012">
                    <CLASS code="00000" name="全国" level="1"/>
                    <CLASS code="01000" name="北海道" level="2" parentCode="00000"/>
                    <CLASS code="02000" name="青森県" level="2" parentCode="00000"/>
                    …
                </CLASS_OBJ>
                <CLASS_OBJ id="time" name="時間軸(年次)">
                    <CLASS code="2012000000" name="2012年" level="1"/>
                </CLASS_OBJ>
            </CLASS_INF>
            <CLASS_INF requestNo="2">
                <CLASS_OBJ id="tab" name="表章項目">
                    <CLASS code="02" name="建物数" level=""/>
                </CLASS_OBJ>
                <CLASS_OBJ id="cat01" name="住宅以外で人が居住する建物総数">
                    <CLASS code="00" name="総数" level="1"/>
                    <CLASS code="01" name="会社等の寮・寄宿舎" level="1"/>
                    <CLASS code="02" name="学校等の寮・寄宿舎" level="1"/>
                    <CLASS code="03" name="旅館・宿泊所" level="1"/>
                    <CLASS code="04" name="その他の建物" level="1"/>
                </CLASS_OBJ>
                <CLASS_OBJ id="cat02" name="全域・人口集中地区の別">
                    <CLASS code="00" name="全域" level="1"/>
                    <CLASS code="03" name="人口集中地区" level="1"/>
                </CLASS_OBJ>
                <CLASS_OBJ id="area" name="H20地域(ALL)">
                    <CLASS code="00000" name="全国" level="1"/>
                    <CLASS code="00001" name="市部" level="2"/>
                    <CLASS code="01000" name="北海道" level="2"/>
                    <CLASS code="02000" name="青森県" level="2"/>
                    …
                </CLASS_OBJ>
                <CLASS_OBJ id="time" name="時間軸(年次)">
                    <CLASS code="2008000000" name="2008年" level="1"/>
                </CLASS_OBJ>
            </CLASS_INF>
        </CLASS_INF_LIST>
        <DATA_INF_LIST>
            <DATA_INF requestNo="1">
                <NOTE char="*">平均値及び割合の算出に当たって除数が表章単位に満たないもの</NOTE>
                <NOTE char="-">該当数値のないもの,又は平均値及び割合の算出に当たって除数が0のもの</NOTE>
                <NOTE char="...">平均値及び割合の算出に当たって除数が表章単位に満たないもの,または増減率及び構成比の算出に当たって除数が1万人未満の場合</NOTE>
                <NOTE char="X">数字が秘匿されているもの</NOTE>
                <VALUE tab="006" cat01="000" area="00000" time="2012000000" unit="世帯">28547900</VALUE>
                <VALUE tab="006" cat01="000" area="01000" time="2012000000" unit="世帯">1289100</VALUE>
                <VALUE tab="006" cat01="000" area="02000" time="2012000000" unit="世帯">278500</VALUE>
                <VALUE tab="006" cat01="000" area="03000" time="2012000000" unit="世帯">263800</VALUE>
                <VALUE tab="006" cat01="000" area="04000" time="2012000000" unit="世帯">482500</VALUE>
                <VALUE tab="006" cat01="000" area="05000" time="2012000000" unit="世帯">226200</VALUE>
                <VALUE tab="006" cat01="000" area="06000" time="2012000000" unit="世帯">226000</VALUE>
                <VALUE tab="006" cat01="000" area="07000" time="2012000000" unit="世帯">410200</VALUE>
                <VALUE tab="006" cat01="000" area="08000" time="2012000000" unit="世帯">638800</VALUE>
                <VALUE tab="006" cat01="000" area="09000" time="2012000000" unit="世帯">436000</VALUE>
            </DATA_INF>
            <DATA_INF requestNo="2">
                <NOTE char="-">該当数字が皆無のもの,又は数字が得られないもの  </NOTE>
                <NOTE char="...">   </NOTE>
                <NOTE char="X">   </NOTE>
                <VALUE tab="02" cat01="00" cat02="00" area="00000" time="2008000000">74600</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="00001" time="2008000000">61700</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="01000" time="2008000000">4700</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="02000" time="2008000000">1300</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="03000" time="2008000000">1100</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="04000" time="2008000000">1300</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="05000" time="2008000000">1200</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="06000" time="2008000000">1100</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="07000" time="2008000000">1500</VALUE>
                <VALUE tab="02" cat01="00" cat02="00" area="08000" time="2008000000">1500</VALUE>
            </DATA_INF>
        </DATA_INF_LIST>
    </STATISTICAL_DATA_LIST>
</GET_STATS_DATAS>

4.8.4. JSON形式出力サンプル


{
  "GET_STATS_DATAS": {
    "RESULT": {
      "STATUS": 0,
      "ERROR_MSG": "正常に終了しました。",
      "DATE": "2016-03-30T17:08:33.737+09:00"
    },
    "PARAMETER_LIST": {
      "LANG": "J",
      "DATA_FORMAT": "J",
      "META_GET_FLG": "Y",
      "PARAMETER": [
        {
          "@requestNo": "1",
          "STATS_DATA_ID": "0003090287",
          "START_POSITION": 1,
          "LIMIT": 10
        },
        {
          "@requestNo": "2",
          "STATS_DATA_ID": "0003010900",
          "START_POSITION": 1,
          "LIMIT": 10
        }
      ]
    },
    "STATISTICAL_DATA_LIST": {
      "RESULT_INF": {
        "TOTAL_NUMBER": 1642
      },
      "TABLE_INF_LIST": {
        "TABLE_INF": [
          {
            "@id": "0003090287",
            "@requestNo": "1",
            "STAT_NAME": {
              "@code": "00200532",
              "$": "就業構造基本調査"
            },
            "GOV_ORG": {
              "@code": "00200",
              "$": "総務省"
            },
            "STATISTICS_NAME": "平成24年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏) 世帯単位で見た統計表",
            "TITLE": {
              "@no": "410101",
              "$": "世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県"
            },
            "CYCLE": "-",
            "SURVEY_DATE": 201210,
            "OPEN_DATE": "2014-03-20",
            "SMALL_AREA": 0,
            "MAIN_CATEGORY": {
              "@code": "03",
              "$": "労働・賃金"
            },
            "SUB_CATEGORY": {
              "@code": "01",
              "$": "労働力"
            },
            "OVERALL_TOTAL_NUMBER": 1392,
            "UPDATED_DATE": "2014-03-19",
            "STATISTICS_NAME_SPEC": {
              "TABULATION_CATEGORY": "平成24年就業構造基本調査",
              "TABULATION_SUB_CATEGORY1": "地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏)",
              "TABULATION_SUB_CATEGORY2": "世帯単位で見た統計表"
            },
            "TITLE_SPEC": {
              "TABLE_NAME": "世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県"
            }
          },
          {
            "@id": "0003010900",
            "@requestNo": "2",
            "STAT_NAME": {
              "@code": "00200522",
              "$": "住宅・土地統計調査"
            },
            "GOV_ORG": {
              "@code": "00200",
              "$": "総務省"
            },
            "STATISTICS_NAME": "平成20年住宅・土地統計調査 全国編",
            "TITLE": {
              "@no": "001-2",
              "$": "居住世帯の有無(9区分)別住宅数及び建物の種類(4区分)別住宅以外で人が居住する建物数―全国,人口集中地区"
            },
            "CYCLE": "-",
            "SURVEY_DATE": 200810,
            "OPEN_DATE": "2010-03-30",
            "SMALL_AREA": 0,
            "MAIN_CATEGORY": {
              "@code": "08",
              "$": "住宅・土地・建設"
            },
            "SUB_CATEGORY": {
              "@code": "01",
              "$": "住宅・土地"
            },
            "OVERALL_TOTAL_NUMBER": 250,
            "UPDATED_DATE": "2010-03-30",
            "STATISTICS_NAME_SPEC": {
              "TABULATION_CATEGORY": "平成20年住宅・土地統計調査",
              "TABULATION_SUB_CATEGORY1": "全国編"
            },
            "TITLE_SPEC": {
              "TABLE_NAME": "居住世帯の有無(9区分)別住宅数及び建物の種類(4区分)別住宅以外で人が居住する建物数―全国,人口集中地区"
            }
          }
        ]
      },
      "CLASS_INF_LIST": {
        "CLASS_INF": [
          {
            "@requestNo": "1",
            "CLASS_OBJ": [
              {
                "@id": "tab",
                "@name": "表章項目",
                "CLASS": {
                  "@code": "006",
                  "@name": "世帯数",
                  "@level": "",
                  "@unit": "世帯"
                }
              },
              {
                "@id": "cat01",
                "@name": "世帯家族類型,夫妻の就業状態・有業の親有無-2012",
                "CLASS": [
                  {
                    "@code": "000",
                    "@name": "総数",
                    "@level": "1"
                  },
                  {
                    "@code": "001",
                    "@name": "夫婦のみの世帯",
                    "@level": "2"
                  },
                  {
                    "@code": "002",
                    "@name": "夫婦ともに有業",
                    "@level": "3"
                  },
                  …
              },
              {
                "@id": "area",
                "@name": "地域2012",
                "CLASS": [
                  {
                    "@code": "00000",
                    "@name": "全国",
                    "@level": "1"
                  },
                  {
                    "@code": "01000",
                    "@name": "北海道",
                    "@level": "2",
                    "@parentCode": "00000"
                  },
                  {
                    "@code": "02000",
                    "@name": "青森県",
                    "@level": "2",
                    "@parentCode": "00000"
                  },
                  …
              },
              {
                "@id": "time",
                "@name": "時間軸(年次)",
                "CLASS": {
                  "@code": "2012000000",
                  "@name": "2012年",
                  "@level": "1"
                }
              }
            ]
          },
          {
            "@requestNo": "2",
            "CLASS_OBJ": [
              {
                "@id": "tab",
                "@name": "表章項目",
                "CLASS": {
                  "@code": "02",
                  "@name": "建物数",
                  "@level": ""
                }
              },
              {
                "@id": "cat01",
                "@name": "住宅以外で人が居住する建物総数",
                "CLASS": [
                  {
                    "@code": "00",
                    "@name": "総数",
                    "@level": "1"
                  },
                  {
                    "@code": "01",
                    "@name": "会社等の寮・寄宿舎",
                    "@level": "1"
                  },
                  {
                    "@code": "02",
                    "@name": "学校等の寮・寄宿舎",
                    "@level": "1"
                  },
                  {
                    "@code": "03",
                    "@name": "旅館・宿泊所",
                    "@level": "1"
                  },
                  {
                    "@code": "04",
                    "@name": "その他の建物",
                    "@level": "1"
                  }
                ]
              },
              {
                "@id": "cat02",
                "@name": "全域・人口集中地区の別",
                "CLASS": [
                  {
                    "@code": "00",
                    "@name": "全域",
                    "@level": "1"
                  },
                  {
                    "@code": "03",
                    "@name": "人口集中地区",
                    "@level": "1"
                  }
                ]
              },
              {
                "@id": "area",
                "@name": "H20地域(ALL)",
                "CLASS": [
                  {
                    "@code": "00000",
                    "@name": "全国",
                    "@level": "1"
                  },
                  {
                    "@code": "00001",
                    "@name": "市部",
                    "@level": "2"
                  },
                  {
                    "@code": "01000",
                    "@name": "北海道",
                    "@level": "2"
                  },
                  {
                    "@code": "02000",
                    "@name": "青森県",
                    "@level": "2"
                  },
                  …
                ]
              },
              {
                "@id": "time",
                "@name": "時間軸(年次)",
                "CLASS": {
                  "@code": "2008000000",
                  "@name": "2008年",
                  "@level": "1"
                }
              }
            ]
          }
        ]
      },
      "DATA_INF_LIST": {
        "DATA_INF": [
          {
            "@requestNo": "1",
            "NOTE": [
              {
                "@char": "*",
                "$": "平均値及び割合の算出に当たって除数が表章単位に満たないもの"
              },
              {
                "@char": "-",
                "$": "該当数値のないもの,又は平均値及び割合の算出に当たって除数が0のもの"
              },
              {
                "@char": "...",
                "$": "平均値及び割合の算出に当たって除数が表章単位に満たないもの,または増減率及び構成比の算出に当たって除数が1万人未満の場合"
              },
              {
                "@char": "X",
                "$": "数字が秘匿されているもの"
              }
            ],
            "VALUE": [
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "00000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "28547900"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "01000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "1289100"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "02000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "278500"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "03000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "263800"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "04000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "482500"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "05000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "226200"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "06000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "226000"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "07000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "410200"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "08000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "638800"
              },
              {
                "@tab": "006",
                "@cat01": "000",
                "@area": "09000",
                "@time": "2012000000",
                "@unit": "世帯",
                "$": "436000"
              }
            ]
          },
          {
            "@requestNo": "2",
            "NOTE": [
              {
                "@char": "-",
                "$": "該当数字が皆無のもの,又は数字が得られないもの  "
              },
              {
                "@char": "...",
                "$": "   "
              },
              {
                "@char": "X",
                "$": "   "
              }
            ],
            "VALUE": [
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "00000",
                "@time": "2008000000",
                "$": "74600"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "00001",
                "@time": "2008000000",
                "$": "61700"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "01000",
                "@time": "2008000000",
                "$": "4700"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "02000",
                "@time": "2008000000",
                "$": "1300"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "03000",
                "@time": "2008000000",
                "$": "1100"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "04000",
                "@time": "2008000000",
                "$": "1300"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "05000",
                "@time": "2008000000",
                "$": "1200"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "06000",
                "@time": "2008000000",
                "$": "1100"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "07000",
                "@time": "2008000000",
                "$": "1500"
              },
              {
                "@tab": "02",
                "@cat01": "00",
                "@cat02": "00",
                "@area": "08000",
                "@time": "2008000000",
                "$": "1500"
              }
            ]
          }
        ]
      }
    }
  }
}

4.8.5. CSV形式出力サンプル

一括取得時のCSV形式出力は以下のフォーマットになります。

タグ名 内容
RESULT 固定文字列
STATUS APIの処理結果情報を出力します。以下の順番に出力されます。
タグ名、結果コード
結果コードが0 ~ 2の場合は正常終了、100 以上の場合はエラーです。
ERROR_MSG APIの処理結果をコードで表します。以下の順番に出力されます。
タグ名、メッセージ
DATE このCSVデータが出力された日時です。以下の順番に出力されます。
タグ名、出力日付
RESULT_INF 固定文字列
TOTAL_NUMBER 絞込条件に一致する統計データの件数です。以下の順番に出力されます。
タグ名、絞込後の件数
TABLE_INF 以下の順番に出力されます。
タグ名、リクエスト番号、統計表ID
STAT_NAME 統計表の政府統計名です。以下の順番に出力されます。
タグ名、政府統計コード、政府統計名
GOV_ORG 統計表の作成機関名です。以下の順番に出力されます。
タグ名、作成機関コード、作成機関名
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。以下の順番に出力されます。
タグ名、提供統計名及び提供分類名
TITLE 統計表の提供周期です。以下の順番に出力されます。
タグ名、表番号, 表題
CYCLE 統計表の提供周期です。以下の順番に出力されます。
タグ名、提供周期
SURVEY_DATE 統計の調査年月です。以下の順番に出力されます。
タグ名、統計年月
OPEN_DATE 統計の公開日です。以下の順番に出力されます。
タグ名、公開日
SMALL_AREA 小地域属性のフラグです。以下の順番に出力されます。
タグ名、小地域フラグ
MAIN_CATEGORY 統計大分野名です。以下の順番に出力されます。
タグ名、統計大分野コード、統計大分野名
SUB_CATEGORY 統計小分野名です。以下の順番に出力されます。
タグ名、統計小分野コード、統計小分野名
OVERALL_TOTAL_NUMBER 統計データの絞込条件なしでの総件数です。以下の順番に出力されます。
タグ名、絞込条件なしでの総件数。
UPDATED_DATE 統計データの最終更新日です。以下の順番に出力されます。
タグ名、最終更新日付
STATISTICS_NAME_SPEC 統計表の提供統計名及び提供分類名の詳細です。以下の順番に出力されます。
タグ名、提供統計名、提供分類名1、提供分類名2、提供分類名3、提供分類名4、提供分類名5
※未設定の項目は、空文字が出力されます。
TITLE_SPEC 統計表の表題の詳細です。以下の順番に出力されます。
タグ名、表分類名、表名、表名区分1、表名区分2、表名区分3
※未設定の項目は、空文字が出力されます。
NOTE 特殊文字の凡例です。特殊文字の数分だけ出力されます。以下の順番に出力されます。
タグ名、リクエスト番号、統計表ID、特殊文字、説明
VALUE 固定文字列
統計数値表列タイトル 統計数値表の列タイトルです。1行だけ出力されます。以下の順番に出力されます。
requestNo、
id、
tab_code、
表章事項の名称、
cat01_code、
分類事項01の名称、

cat15_code、
分類事項15の名称、
area_code、
地域事項の名称、
time_code、
時間軸事項の名称、
unit、
value

※tab、cat01~cat15、areaおよびtimeで始まるものは、データが存在する場合のみ出力されます。

統計数値表 統計数値(セル)の情報です。データ件数分だけ出力されます。以下の順番に出力されます。
リクエスト番号、
統計表ID
表章事項要素コード、
表章事項要素名、
分類事項01要素コード、
分類事項01要素名、

分類事項15要素コード、
分類事項15要素名、
地域事項要素コード、
地域事項要素名、
時間軸事項要素コード、
時間軸事項要素名、
単位名、
統計数値

※表章事項要素、分類事項01~15要素、地域事項要素および時間軸要素は、データが存在する場合のみ出力されます。

RESULT、RESULT_INF、TABLE_INFおよびNOTEはsectionHeaderFlg=2の場合、出力されません。
以下の場合、RESULT情報のみが出力されます。
・結果コードが100以上の場合。
・結果コードが1で表示すべきデータがなく、sectionHeaderFlg=2の場合。

以下は出力例です。

"RESULT"
"STATUS","0"
"ERROR_MSG","正常に終了しました。"
"DATE","2016-03-30T17:30:27.404+09:00"
"RESULT_INF"
"TOTAL_NUMBER","1642"
"TABLE_INF","1","0003090287"
"STAT_NAME","00200532","就業構造基本調査"
"GOV_ORG","00200","総務省"
"STATISTICS_NAME","平成24年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏) 世帯単位で見た統計表"
"TITLE","410101","世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県"
"CYCLE","-"
"SURVEY_DATE","201210"
"OPEN_DATE","2014-03-20"
"SMALL_AREA","0"
"MAIN_CATEGORY","03","労働・賃金"
"SUB_CATEGORY","01","労働力"
"OVERALL_TOTAL_NUMBER","1392"
"UPDATED_DATE","2014-03-19"
"STATISTICS_NAME_SPEC","平成24年就業構造基本調査","地域別主要結果編(全国,都道府県,県庁所在都市,人口30万以上の市,県内経済圏)","世帯単位で見た統計表","","",""
"TITLE_SPEC","","世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県","","",""
"NOTE","1","0003090287","*","平均値及び割合の算出に当たって除数が表章単位に満たないもの"
"NOTE","1","0003090287","-","該当数値のないもの,又は平均値及び割合の算出に当たって除数が0のもの"
"NOTE","1","0003090287","...","平均値及び割合の算出に当たって除数が表章単位に満たないもの,または増減率及び構成比の算出に当たって除数が1万人未満の場合"
"NOTE","1","0003090287","X","数字が秘匿されているもの"
"VALUE"
"requestNo","id","tab_code","表章項目","cat01_code","世帯家族類型,夫妻の就業状態・有業の親有無-2012","area_code","地域2012","time_code","時間軸(年次)","unit","value"
"1","0003090287","006","世帯数","000","総数","00000","全国","2012000000","2012年","世帯","28547900"
"1","0003090287","006","世帯数","000","総数","01000","北海道","2012000000","2012年","世帯","1289100"
"1","0003090287","006","世帯数","000","総数","02000","青森県","2012000000","2012年","世帯","278500"
"1","0003090287","006","世帯数","000","総数","03000","岩手県","2012000000","2012年","世帯","263800"
"1","0003090287","006","世帯数","000","総数","04000","宮城県","2012000000","2012年","世帯","482500"
"1","0003090287","006","世帯数","000","総数","05000","秋田県","2012000000","2012年","世帯","226200"
"1","0003090287","006","世帯数","000","総数","06000","山形県","2012000000","2012年","世帯","226000"
"1","0003090287","006","世帯数","000","総数","07000","福島県","2012000000","2012年","世帯","410200"
"1","0003090287","006","世帯数","000","総数","08000","茨城県","2012000000","2012年","世帯","638800"
"1","0003090287","006","世帯数","000","総数","09000","栃木県","2012000000","2012年","世帯","436000"
"TABLE_INF","2","0003010900"
"STAT_NAME","00200522","住宅・土地統計調査"
"GOV_ORG","00200","総務省"
"STATISTICS_NAME","平成20年住宅・土地統計調査 全国編"
"TITLE","001-2","居住世帯の有無(9区分)別住宅数及び建物の種類(4区分)別住宅以外で人が居住する建物数―全国,人口集中地区"
"CYCLE","-"
"SURVEY_DATE","200810"
"OPEN_DATE","2010-03-30"
"SMALL_AREA","0"
"MAIN_CATEGORY","08","住宅・土地・建設"
"SUB_CATEGORY","01","住宅・土地"
"OVERALL_TOTAL_NUMBER","250"
"UPDATED_DATE","2010-03-30"
"STATISTICS_NAME_SPEC","平成20年住宅・土地統計調査","全国編","","","",""
"TITLE_SPEC","","居住世帯の有無(9区分)別住宅数及び建物の種類(4区分)別住宅以外で人が居住する建物数―全国,人口集中地区","","",""
"NOTE","2","0003010900","-","該当数字が皆無のもの,又は数字が得られないもの  "
"NOTE","2","0003010900","...","   "
"NOTE","2","0003010900","X","   "
"VALUE"
"requestNo","id","tab_code","表章項目","cat01_code","住宅以外で人が居住する建物総数","cat02_code","全域・人口集中地区の別","area_code","H20地域(ALL)","time_code","時間軸(年次)","unit","value"
"2","0003010900","02","建物数","00","総数","00","全域","00000","全国","2008000000","2008年","","74600"
"2","0003010900","02","建物数","00","総数","00","全域","00001","市部","2008000000","2008年","","61700"
"2","0003010900","02","建物数","00","総数","00","全域","01000","北海道","2008000000","2008年","","4700"
"2","0003010900","02","建物数","00","総数","00","全域","02000","青森県","2008000000","2008年","","1300"
"2","0003010900","02","建物数","00","総数","00","全域","03000","岩手県","2008000000","2008年","","1100"
"2","0003010900","02","建物数","00","総数","00","全域","04000","宮城県","2008000000","2008年","","1300"
"2","0003010900","02","建物数","00","総数","00","全域","05000","秋田県","2008000000","2008年","","1200"
"2","0003010900","02","建物数","00","総数","00","全域","06000","山形県","2008000000","2008年","","1100"
"2","0003010900","02","建物数","00","総数","00","全域","07000","福島県","2008000000","2008年","","1500"
"2","0003010900","02","建物数","00","総数","00","全域","08000","茨城県","2008000000","2008年","","1500"