API機能の仕様の詳細は、以下を参照してください。
API仕様・・・2019/ 7/ 26提供開始 
統計データをXML、JSON、CSVで提供する仕様です(Word / PDF / HTML)
現在のバージョン: 3.0
ホスト名: api.e-stat.go.jp
リクエストURL: http://api.e-stat.go.jp/rest/3.0/app/・・・
(1)CSV形式でのデータ取得機能を追加
・統計表情報取得機能及びメタ情報取得機能にCSV形式でのデータ取得機能を追加しました。
(2)集計地域区分の追加
・集計地域区分を指定するパラメータ「collectArea」及び集計地域区分の出力を追加しました。
(3)統計表、提供統計、提供分類及びメタ情報の解説の追加
・統計表、提供統計、提供分類及びメタ情報の解説有無を指定するパラメータ「explanationGetFlg」及び解説の出力を追加しました。
(4)統計数値の注釈の追加
・統計データ取得機能、統計データ一括取得機能に注釈情報有無を指定するパラメータ「annotationGetFlg」及び注釈の出力を追加しました。
(5)検索データ種別から、社会・人口統計体系の提供を廃止
・統計表情報取得機能の検索データ種別を指定するパラメータ「searchKind」において、社会・人口統計体系の統計表情報取得に「3:社会・人口統計体系(都道府県・市区町村のすがた)」の指定は不要なため、当該検索データ種別を廃止しました。
※「1:統計情報」、「2:小地域・地域メッシュ」につきましては、引き続き利用いただけます。
API仕様・・・2016/ 7/14提供開始
統計データをXML、JSON、CSVで提供する仕様です(Word / PDF / HTML)
現在のバージョン: 2.1
ホスト名: api.e-stat.go.jp
リクエストURL: http://api.e-stat.go.jp/rest/2.1/app/・・・
(1)CSVによる統計データ取得機能の追加
・統計データ取得機能にCSV形式での取得機能を追加しました。
(2)統計データ一括取得機能の追加
・複数の統計データを一括で取得できる機能を追加しました。
(3)各機能の統計表情報に提供分類名及び統計表名を分割出力したタグを追加
・STATISTICS_NAME_SPECタグ及びTITLE_SPECタグを追加しました。
API仕様・・・2015/ 1/30提供開始
統計データをXML、JSONで提供する仕様です(Word / PDF / HTML)
現在のバージョン: 2.0
ホスト名: api.e-stat.go.jp
リクエストURL: http://api.e-stat.go.jp/rest/2.0/app/・・・
(1)データカタログ情報取得機能の追加
・政府統計の総合窓口(e-Stat)において提供しているすべての統計データ(EXCEL等を含む)の一覧情報(調査名、表題、リンク情報等)をAPIで取得できる機能を追加しました。
(2)すべてのAPI機能の提供フォーマットをJSONに対応
・今まで統計データ取得機能のみに実装されていましたが、すべてのAPI機能の提供フォーマットをJSONに対応しました。
(3)統計表情報取得に更新情報を提供する機能などを追加
・統計表情報取得機能に更新日付を指定するパラメータ「updatedDate」を追加しました。
・「searchWord.検索キーワード」パラメータの演算子に「NOT」を追加しました。
【パラメータ指定例】
※指定する文字はすべてURLエンコードする必要があります。
・「学校基本調査」で「公立の内訳」を含まない統計を検索する場合
searchWord=学校基本調査 NOT 公立の内訳
・「学校基本調査」で「公立の内訳」および「国立・公立・私立【計】」を含まない統計を検索する場合
searchWord=学校基本調査 NOT (公立の内訳 OR 国立・公立・私立【計】)
- (4)各機能の統計表情報の出力タグの統一など、出力データの一部を修正
・統計表情報取得、メタ情報取得、統計データ取得及びデータセット参照機能における「統計表の情報.TABLE_INFタグ」を統一しました。詳しくは、以下表1を参照してください。
・各機能の「統計表の情報.TABLE_INFタグ」にMAIN_CATEGORYタグ、SUB_CATEGORYタグ、OVERALL_TOTAL_NUMBERタグ及びUPDATED_DATEタグを追加しました。
・統計表情報取得のLIST_INFタグをTABLE_INFタグに変更しました。
・データセット参照のLIST_INFタグをDATASET_INFタグに変更しました。
・統計表情報取得及び統計データ取得にRESULT_INFタグを追加しました。
【RESULT_INFタグの出力情報】
統計表情報取得:FROM_NUMBERタグ,TO_NUMBERタグ及びNEXT_KEYタグ
統計データ取得:TOTAL_NUMBERタグ,FROM_NUMBERタグ,TO_NUMBERタグ及びNEXT_KEYタグ
表1:(4)各機能の「統計表情報.TABLE_INFタグ」について
タグ |
バージョン1.0 |
バージョン
2.0 |
---|
統計表情報
取得 |
メタ情報
取得 |
統計データ
取得 |
データセット
参照 |
---|
STAT_NAME |
● |
● |
● |
● |
● |
GOV_ORG |
● |
● |
● |
● |
● |
STATISTICS_NAME |
● |
● |
● |
● |
● |
TITLE |
● |
● |
● |
● |
● |
CYCLE |
● |
|
|
|
● |
SURVEY_DATE |
● |
● |
● |
|
● |
OPEN_DATE |
● |
|
|
|
● |
SMALL_AREA |
● |
|
|
|
● |
MAIN_CATEGORY |
|
|
|
|
● |
SUB_CATEGORY |
|
|
|
|
● |
OVERALL_TOTAL_NUMBER |
|
|
|
|
● |
UPDATED_DATE |
|
|
|
|
● |
API仕様・・・2014/10/31提供開始
統計データをXML、JSONで提供する仕様です(Word / PDF)
現在のバージョン: 1.0
ホスト名: api.e-stat.go.jp
リクエストURL: http://api.e-stat.go.jp/rest/1.0/app/・・・
gzip圧縮による通信量の削減
APIの各リクエストURLは、gzipによる圧縮形式でのレスポンスに対応しています。
APIのレスポンスをgzip形式で取得すると、データの転送量を減らすことができるので、処理の高速化につながります。gzip圧縮されたAPIのレスポンスを受信するには、HTTPのリクエストヘッダ(「Accept-Encoding」ヘッダ)を「gzip」に設定して、APIをリクエストする必要があります。
※gzip圧縮されたAPIのレスポンスは、別途解凍が必要です。
(HTTPリクエストヘッダの設定) Accept-Encoding: gzip
CORS(Cross Origin Resource Sharing)対応
APIの以下リクエストURLは、クロスオリジンリソースシェアリング(CORS)に対応しています。
そのため、XMLHttpRequset(Level 2)に対応しているブラウザであれば、XMLHttpRequestを利用してクロスドメイン通信をすることが可能です。
対応リクエストURL: http://api.e-stat.go.jp/rest/<バージョン>/app/json/・・・