本記事はヴァル研究所の支援として作成された記事です

駅すぱあとはAPIを公開しており、駅情報や経路探索などをAPI経由で行えます。メソッドはすべてGETメソッドで、情報取得系のみです。レスポンスはJSONまたはXMLで返ってきます。

この駅すぱあと APIを利用しやすくするSDKを開発しています。SDKはVBAとPython、Google Apps Scriptで開発していますが、いずれも非公式SDKなので、公式への問い合わせはご遠慮ください。

今回は、スタンダードプランで提供されている範囲探索APIに対応しましたので、その使い方を紹介します。

範囲探索機能はN分以内で行ける駅を探す機能ですが、例えば不動産サイトやバイト探しサイトの「通勤時間から探す」機能や、通勤時間から配置できる店舗を探す「人員配置」などによく採用される機能です。

それでは、SDKの使い方について解説します。

必要な情報

SDKを利用する際にはAPIキーが必要です。無料トライアルがあるので、こちらから取得してください。

注意点

SDKは非公式です。公式サポートへの問い合わせはご遠慮ください

インストール

インストールは ライブラリID を指定して行います。

1lJW_-jvxWQbOHq-TUe1Dab3picc8nx5gZHb8vvxSqe43HkP9hNMjF-d8

デフォルトでは EkispertSDKComm がIDです。以下はそれに沿って記述します。

初期化

先ほど取得したAPIキーを使ってSDKを初期化します。

const client = new EkispertSDKComm.Client('YOUR_API_KEY');

範囲探索の探索条件の設定

範囲探索は MultipleRangeQuery を使います。このオブジェクトを取得し、検索条件を設定します。

const query = client.multipleRangeQuery();

// 探索条件の設定
query.baseList = ["有楽町"];
query.upperMinute = [15];

探索条件は範囲探索 - 駅すぱあと API Documents 駅データ・経路検索のWebAPI にあるものを指定できます。

検索の実行

探索条件を設定したら、探索処理を実行します。結果は base と points キーを持ったオブジェクトになります。

try {
  const response = query.execute();
} catch (e) {
  console.error(e.code);
  console.error(e.message);
}

成功した場合

処理が成功した場合、 base キーに起点を表すオブジェクト、 points キーに地点情報が入っています。各地点情報には station （駅情報）や geo_point （位置情報）、 cost （起点駅毎の所要時間や乗換回数を表す情報）プロパティなどがあります。

console.log(response.points.length); // 42
console.log(response.points[0].station.name); // 日比谷
console.log(response.points[0].prefecture.name); // 東京都
console.log(response.points[0].prefecture.code); // 13

ソースコード

SDKのコードは以下のリポジトリにて公開しています。ライセンスはMIT Licenseです。

ソースコード

SDKのコードは以下のリポジトリにて公開しています。ライセンスはMIT Licenseです。

EkispertAPIMania/gas-sdk

まとめ

経路探索は今回紹介したものの他、前後のダイヤ探索や平均待ち時間探索などさまざまな種類があります。今後のSDKのアップデートにて対応する予定なので、ぜひご利用ください。

何か不具合があれば、Issueにて連絡いただければ対応します。

EkispertAPIMania/gas-sdk