本記事はヴァル研究所の支援として作成された記事です
駅すぱあとは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"
緯度経度からの周辺駅検索条件の設定
緯度経度からの周辺駅検索は GeoStationQuery
を使います。このオブジェクトを取得し、検索条件を設定します。
Dim Query As GeoStationQuery
Set Query = client.GeoStationQuery()
' 緯度経度の設定
Query.GeoPoint "35.6585805", "139.7454329", GCSEnum.Tokyo, 500
' コミュニティバスの指定
Query.CommunityBus = Except
検索条件は 緯度経度からの周辺駅検索 - 駅すぱあと API Documents 駅データ・経路検索のWebAPI にあるものを指定できます。type
はVBAの予約語なので、TransportTypeプロパティにて指定します。
位置情報の指定は、1〜2つ目の引数である緯度・経度は必須です。3つ目の引数は測地系で、デフォルトは GCSEnum.Tokyo
です( GCSEnum.Wgs84
も指定できます)。4つ目の引数は検索範囲(メートル)で、デフォルトは無制限です。
なお、緯度経度のデフォルトは日本測地系になります。Googleでは世界測地系が採用されていますので、Googleマップなどで表示したい際には世界測地系を指定 Wgs84
してください。
検索の実行
検索条件を設定したら、検索処理を実行します。結果は 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
(駅情報) や GeoPoint
(位置情報) プロパティなどがあります。
Dim i As Long
For i = 0 To UBound(Result.Points)
Debug.Print Result.Points(i).Station.Name ' 駅名
Debug.Print Result.Points(i).GeoPoint.Latitude_DD & "," & Result.Points(i).GeoPoint.Longitude_DD ' 緯度経度
Next
ソースコード
SDKのコードは以下のリポジトリにて公開しています。ライセンスはMIT Licenseです。
EkispertAPIMania/VBA-SDK: Excel VBAなどで動作する駅すぱあと VBA SDKです(Windowsのみ)
まとめ
周辺駅検索は今回紹介したものの他、住所情報からの検索もできます。今後のSDKのアップデートにて対応する予定なので、ぜひご利用ください。
何か不具合があれば、Issueにて連絡いただければ対応します(macOSでは動かないので注意してください)。
EkispertAPIMania/VBA-SDK: Excel VBAなどで動作する駅すぱあと VBA SDKです(Windowsのみ)