パラメータ名
意味
必須
設定内容・設定可能値
入力欄
appId
アプリケーションID
〇
取得したアプリケーションIDを指定して下さい。
自身のアプリケーションでAPIを使用する場合はここで指定する必要があります。 本サイトでは、本サイトに与えられたアプリケーションIDが自動で指定されます。
lang
言語
-
取得するデータの言語を 以下のいずれかを指定して下さい。
- J:日本語 (省略値)
- E:英語
dataSetId
データセットID ※1,2
△
「データセット登録」で登録したデータセットID です。
※1 データセットID 又は 統計表ID
のいずれか一方を必ず指定して下さい。どちらも指定しない場合や両方指定した場合はエラーとなります。
のいずれか一方を必ず指定して下さい。どちらも指定しない場合や両方指定した場合はエラーとなります。
※2 データセットID
を指定した場合、そのデータセットに登録されている絞り込み条件を元にデータを取得します。
データセットIDと絞り込み条件を指定した場合は、データセットに登録されている条件から更に絞り込むことができます。
を指定した場合、そのデータセットに登録されている絞り込み条件を元にデータを取得します。
データセットIDと絞り込み条件を指定した場合は、データセットに登録されている条件から更に絞り込むことができます。
本サイトでは指定できません。
statsDataId
統計表ID ※1
△
「統計表情報取得」で得られる統計表IDです。
※1 データセットID 又は 統計表ID
のいずれか一方を必ず指定して下さい。どちらも指定しない場合や両方指定した場合はエラーとなります。
のいずれか一方を必ず指定して下さい。どちらも指定しない場合や両方指定した場合はエラーとなります。
絞り込み条件
※2 データセットID を指定した場合、そのデータセットに登録されている絞り込み条件を元にデータを取得します。 データセットIDと絞り込み条件を指定した場合は、データセットに登録されている条件から更に絞り込むことができます。
lvTab
表章事項 階層レベル
-
以下のいずれかの形式で指定して下さい。
(Xは「メタ情報取得」で得られる各メタ情報の階層レベル)
・X:指定階層レベルのみで絞り込み
・X-X:指定階層レベルの範囲で絞り込み
・-X:階層レベル1 から指定階層レベルの範囲で絞り込み
・X-:指定階層レベルから階層レベル 9 の範囲で絞り込み
(Xは「メタ情報取得」で得られる各メタ情報の階層レベル)
・X:指定階層レベルのみで絞り込み
・X-X:指定階層レベルの範囲で絞り込み
・-X:階層レベル1 から指定階層レベルの範囲で絞り込み
・X-:指定階層レベルから階層レベル 9 の範囲で絞り込み
cdTab
表章事項 単一コード ※3
-
特定の項目コードでの絞り込み
「メタ情報取得」で得られる各メタ情報の項目コードを指定して下さい。
コードはカンマ区切りで100個まで指定可能です。
※3 以下の特別なキーワードを指定可能です。 min:最小値 max:最大値 min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。 単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。
「メタ情報取得」で得られる各メタ情報の項目コードを指定して下さい。
コードはカンマ区切りで100個まで指定可能です。
※3 以下の特別なキーワードを指定可能です。 min:最小値 max:最大値 min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。 単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。
cdTabFrom
表章事項 コード From ※3
-
項目コードの範囲で絞り込み
絞り込む範囲の開始位置の項目コードを指定して下さい。
※3 以下の特別なキーワードを指定可能です。 min:最小値 max:最大値 min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。 単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。
絞り込む範囲の開始位置の項目コードを指定して下さい。
※3 以下の特別なキーワードを指定可能です。 min:最小値 max:最大値 min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。 単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。
cdTabTo
表章事項 コード To ※3
-
項目コードの範囲で絞り込み
絞り込む範囲の終了位置の項目コードを指定して下さい。
※3 以下の特別なキーワードを指定可能です。 min:最小値 max:最大値 min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。 単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。
絞り込む範囲の終了位置の項目コードを指定して下さい。
※3 以下の特別なキーワードを指定可能です。 min:最小値 max:最大値 min及びmaxはそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。 単一コードでmin又はmaxを使用する場合には、カンマ区切りによる複数の項目コード指定はできません。
lvTime
時間軸事項 階層レベル
-
表章事項の階層レベルと同様です。
cdTime
時間軸事項 単一コード
-
表章事項の単一コードと同様です。
cdTimeFrom
時間軸事項 コード From
-
表章事項のコード Fromと同様です。
cdTimeTo
時間軸事項 コード To
-
表章事項のコード Toと同様です。
lvArea
地域事項 階層レベル
-
表章事項の階層レベルと同様です。
cdArea
地域事項 単一コード
-
表章事項の単一コードと同様です。
cdAreaFrom
地域事項 コード From
-
表章事項のコード Fromと同様です。
cdAreaTo
地域事項 コード To
-
表章事項のコード Toと同様です。
lvCat01
分類事項 階層レベル
-
表章事項の階層レベルと同様です。
cdCat01
分類事項 単一コード
-
表章事項の単一コードと同様です。
cdCat01From
分類事項 コード From
-
表章事項のコード Fromと同様です。
cdCat01To
分類事項 コード To
-
表章事項のコード Toと同様です。
・・・
分類事項02 ~ 15
-
分類事項01と同様です。
重複するパラメータ名を指定した場合、最後に指定した値が使用されます(本サイトでの仕様)
その他の条件
startPosition
データ取得開始位置
-
データの取得開始位置(1から始まる行番号)を指定して下さい。
省略時は先頭から取得します。
統計データを複数回に分けて取得する場合等、継続データを取得する開始位置を指定するために指定します。
前回受信したデータのタグの値を指定します。
省略時は先頭から取得します。
統計データを複数回に分けて取得する場合等、継続データを取得する開始位置を指定するために指定します。
前回受信したデータのタグの値を指定します。
limit
データ取得件数
-
データの取得行数を指定して下さい。省略時は10万件です。
データ件数が指定したlimit値より少ない場合、全件を取得します。データ件数が指定したlimit値より多い場合(継続データが存在する)は、受信したデータの<NEXT_KEY>タグに継続データの開始行が設定されます。
データ件数が指定したlimit値より少ない場合、全件を取得します。データ件数が指定したlimit値より多い場合(継続データが存在する)は、受信したデータの<NEXT_KEY>タグに継続データの開始行が設定されます。
metaGetFlg
メタ情報有無
-
統計データと一緒にメタ情報を取得するか否かを以下のいずれかから指定して下さい。
- Y:取得する (省略値)
- N:取得しない
cntGetFlg
件数取得フラグ
-
指定した場合、件数のみ取得できます。metaGetFlg=Yの場合は、メタ情報も同時に返却されます。
- Y:件数のみ取得する。統計データは取得しない。
- N:件数及び統計データを取得する。(省略値)
explanationGetFlg
解説情報有無
-
統計表及び、提供統計、提供分類、各事項の解説を取得するか否かを以下のいずれかから指定して下さい。
- Y:取得する (省略値)
- N:取得しない
annotationGetFlg
注釈情報有無
-
数値データの注釈を取得するか否かを以下のいずれかから指定して下さい。
- Y:取得する (省略値)
- N:取得しない
replaceSpChar
特殊文字の置換
-
特殊文字を置換するか否かを設定します。
- 置換しない:0(デフォルト)
- 0(ゼロ)に置換する:1
- NULL(長さ0の文字列、空文字)に置換する:2
- NA(文字列)に置換する:3
callback
コールバック関数
△
JSONP形式のデータ呼出の場合は必須パラメータです。
コールバックされる関数名を指定して下さい。
コールバックされる関数名を指定して下さい。
本サイトでは指定できません。
sectionHeaderFlg
セクションヘッダフラグ
-
CSV形式のデータ呼び出しの場合に有効なパラメータです。
- 1:セクションヘッダを出力する (省略値)
- 2:セクションヘッダを取得しない
ファイル形式
GET リクエストの URL
https://api.e-stat.go.jp/rest/3.0/app/json/getStatsData?appId=<アプリケーションID>