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

駅すぱあとは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"

駅簡易情報検索条件の設定

駅簡易情報検索は StationLightQuery を使います。このオブジェクトを取得し、検索条件を設定します。

Dim Query As StationLightQuery
Set Query = client.StationLightQuery()
Query.Name = "東京" ' 駅名で検索

' 都道府県を指定する場合（複数可）
Query.PrefectureCode(0) = Tokyo
Query.PrefectureCode(1) = Kanagawa
' 交通種別の指定
Query.TransportType(0) = LocalBus
' コミュニティバスの扱い
Query.CommunityBus = Except

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

検索の実行

検索条件を設定したら、検索処理を実行します。結果は 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.Points の中にポイント情報が入っています。各ポイントには Station （駅情報）と Prefecture （都道府県）プロパティなどがあります。

Debug.Print Result.Max ' 200（検索結果数）
Debug.Print Result.Points(0).Station.Code ' 22828
Debug.Print Result.Points(0).Prefecture.Name ' 東京都

Dim i As Long

For i = 0 To UBound(Result.Points)
	Debug.Print i & " " & Result.Points(i).Station.Code
Next i

ソースコード

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

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

まとめ

駅情報の取得は、経路探索の基本になります。まだ経路探索はできませんが、これから徐々に機能を追加していきます。ぜひお試しください。

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

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