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

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

この駅すぱあと APIを利用しやすくするSDKを開発しはじめました。SDKはVBAで作っており、Excelなどから利用できます（Windowsのみ、macOSでは利用できません）。

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

必要な情報

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

注意点

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

ファイルのインポート

こちらのリポジトリにある *.cls と *.bas ファイルをすべてインポートします。これらは以下のライブラリを含んでいます。

初期化

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

Dim client As Ekispert
Set client = New Ekispert
client.ApiKey = "YOUR_API_KEY"

経路探索の探索条件の設定

経路探索は CourseExtremeQuery を使います。このオブジェクトを取得し、探索条件を設定します。

Dim Query As CourseExtremeQuery
Set Query = client.CourseExtremeQuery()

' 出発地、目的地の設定
Query.ViaList(0) = "高円寺"
Query.ViaList(1) = "東京"

' 日付の設定
Query.DateProp = Now

' 探索種別を平均待ち時間探索に設定
Query.SearchType = Plain

探索条件は経路探索 - 駅すぱあと API Documents 駅データ・経路探索のWebAPI にあるものを指定できます。Date はVBAの予約語なので、日時（ date または time）については、 DateProp プロパティへ設定してください。

探索の実行

探索条件を設定したら、探索処理を実行します。結果は ResultSet クラスになります。探索がうまくいったかどうかは ResultSet.Success の値で判定してください。

Dim Result As ResultSet
Result = Query.Find()

Debug.Print Result.Success ' True または False

エラーだった場合

もし探索がエラーだった場合は ResultSet.Error の中にエラー情報があります（駅すぱあと APIからのエラーの場合）。

If Not Result.Success Then
    MsgBox Result.Error.Message
    Exit Sub
End If

成功した場合

処理が成功した場合、 ResultSet.Courses の中に経路情報が入っています。各経路には Prices （金額情報）や Route （ルート）プロパティなどがあります。

Debug.Print Result.Courses(0).Prices(0).Oneway ' 片道運賃。460など

ソースコード

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

EkispertAPIMania/VBA-SDK: Excel VBAなどで動作する駅すぱあと VBA SDKです（Windowsのみ）

まとめ

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

何か不具合があれば、Issueにて連絡いただければ対応します（macOSでは動かないので注意してください）。

EkispertAPIMania/VBA-SDK: Excel VBAなどで動作する駅すぱあと VBA SDKです（Windowsのみ）