StatApiMagic.js とは、政府統計総合窓口(e-Stat)のWeb API専用ライブラリであり、データ構造のコンバータです。
手品で使う魔法の箱をイメージしてネーミングしました。
e-StatのWeb API「統計データ取得」により受け取ったHTTPレスポンスデータ（json）の構造を、利活用しやすいシンプルな形に再構築するものです。
出力形式は、以下の９種類から選択することができます。
| option番号 | 出力フォーマット | シンプル加工 | 項目コード番号 （注１）の付加 | 統計表情報 （注２）の付加 |
0 | json（元データ） | － | － | － | 1 | json | ○ | － | － | 2 | json | ○ | ○ | － | 3 | json | ○ | － | ○ | 4 | json | ○ | ○ | ○ | 5 | csv | ○ | － | － | 6 | csv | ○ | ○ | － | 7 | csv | ○ | － | ○ | 8 | csv | ○ | ○ | ○ |
|---|
（注１） 項目コード番号とは、各要素に割り当てられたコード番号のことです。標準自治体コードや、経済統計の産業分類番号順にソートするとき等に使っていただくと便利です。
（注２） 統計表情報とは、「統計表ID」、「統計調査名」、「名称詳細・集計方法」、「統計表タイトル」です。
e-StatのWeb APIからレスポンスされるXMLやjsonは、その構造上、利用には一定の解析作業が必要であり、アプリケーション開発にも時間と労力が必要です。
そこで、統計データの情報はすべて保持したまま、シンプルで使いやすい構造への再構築を容易に行うことができれば、利便性が劇的に改善され、統計情報の利活用の促進に繋がると考えました。
StatApiMagic.js は、そのような思いから作成したものです。
また、StatApiMagic.js は、 API Search Engine と組み合わせることにより、その利用価値が最大化されます。
これら２つのツールの相互補完作用により、API利活用範囲の拡大や、アプリケーション開発速度の飛躍的な向上が期待できます。
統計API機能を現在利用されている方、これから利用してみようと考えている方に、少しでもお役に立てることを願っております。
StatApiMagic.js は JavaScript の外部ファイルです。HTMLやPHP等から呼び出してご使用ください。
API「統計データ取得」から受け取ったレスポンスのjsonオブジェクトと、「出力形式オプション番号」を引数として、「StatApiMagic関数」へ渡してください。その戻り値が、シンプル加工されたjson又はcsv（カンマ区切り）になります。（データは文字列として返されますので、必要に応じてパースしてご利用ください。）
オプション番号０で取得するjsonは、元データを視認性を向上させるための改行整形をしただけものですが、シンプル化したjsonは、利活用しやすい形に構造自体を変えたものです。
具体的には、ヘッダと値とを分け、それぞれをjsonオブジェクトの「データ」として格納している元データに対し、シンプルjsonは、ヘッダと値を対にし、ヘッダをオブジェクトの「キー」に、値をオブジェクトの「データ」に当てはめたものです。
これら「StatApiMagic関数」の戻り値は、 API Search Engine の「統計表データ取得」から出力される「CSV」又は「Simple json」と全く同じ構造ですので、データ構造の詳細はそちらをご覧ください。
なお、StatApiMagic.js が利用できるのは、政府統計API機能のうち「統計データ取得」のみです。「統計表情報取得」等には使用できませんのでご注意願います。
詳しい使い方は、以下のサンプルコードをご覧ください。