※上図は、範囲探索機能で「東京駅から30分以内」の駅をマッピングした際のイメージです
こんにちは、駅すぱあとWebサービス開発チームです。
この度「駅すぱあとWebサービス」では、範囲探索機能において探索日を指定できるようになりました。
これまでは、検索実行日を探索日としていましたが、今回のアップデートで、検索実行日にかかわらず特定の探索日を指定できるようになりました。 今回の機能により、不動産サイトなどでの「通勤時間から検索して物件を探す」時に、「検索日が平日と土日で検索結果が意図せず変わる」などがなくなり、サービス提供者側が検索結果をコントロールできるようになります。
具体的には
範囲探索機能に探索日を指定するリクエストパラメータが追加されました。
- 機能: 範囲探索(/search/course/extreme)
- リクエストパラメータ:
date
探索日付を指定する。省略可。また、省略時は現在日付。
起点とする駅によっては平日と土日祝で結果が変わることがありますが、date
パラメータを指定することで検索日にかかわらず、期待する日付や曜日の結果を得ることができます。
新宿駅を基点とし、高円寺駅までの所要時間を例として見てみます。 「新宿ー高円寺」間は、平日であればJR中央線快速が利用できますが、土曜・休日・祝日はJR中央線快速が停車しないため利用できずJR総武線を利用することになるため、所要時間が異なります。
まずは平日の結果を見てみます。 サンプルリクエストは以下のとおりです。起点駅に新宿駅(駅コードは22741)指定し、日付を2023年11月10日金曜日を指定します。
https://api.ekispert.jp/v1/xml/search/multipleRange?key=アクセスキー&baseList=22741&upperMinute=30&date=20231110
そうすると、レスポンスでは所要時間は12分でとなります。
<ResultSet apiVersion="1.27.0.0" engineVersion="202311_04a"> : <Point> <Station code="22671"> <Name>高円寺</Name> <Type>train</Type> </Station> <Prefecture code="13"> <Name>東京都</Name> </Prefecture> <Cost baseIndex="1"> <Minute>12</Minute> <TransferCount>0</TransferCount> </Cost> </Point> : </ResultSet>
次に土曜日の結果を見てみます。 サンプルリクエストは以下のとおりです。起点駅に新宿駅(駅コードは22741)指定し、日付を2023年11月11日土曜日を指定します。
https://api.ekispert.jp/v1/xml/search/multipleRange?key=アクセスキー&baseList=22741&upperMinute=30&date=20231111
そうすると、レスポンスでは所要時間は13分でとなります。
<ResultSet apiVersion="1.27.0.0" engineVersion="202311_04a"> : <Point> <Station code="22671"> <Name>高円寺</Name> <Type>train</Type> </Station> <Prefecture code="13"> <Name>東京都</Name> </Prefecture> <Cost baseIndex="1"> <Minute>13</Minute> <TransferCount>0</TransferCount> </Cost> </Point> : </ResultSet>
「常に平日の検索結果を表示させたい」などのニーズがある場合は、APIリクエスト時にサービス側で直近の平日の日付を指定する、などの使い方を想定しています。
おわりに
今回は範囲探索機能のアップデート情報を紹介しました。 曜日などを固定して範囲探索を利用したい場合には、今回の機能をご利用ください。
引き続き、「駅すぱあとWebサービス」をよろしくお願いします。
「駅すぱあとWebサービス」を使ってみるには?
「駅すぱあとWebサービス スタンダードプラン」は90日間無料でお試しできます。 こちらから申し込みして気軽に触ってみてください!