住所情報

リクエストパラメータとしての住所情報です。 以下の情報を指定できます。

住所 住所の文字列。
半径 住所から一定範囲の指定を行うAPIを利用する場合、半径を付加できます。省略可
単位: メートル
指定しない場合は最寄りの1件のデータを返します。

経路探索で用いた際、検索された住所から最寄り駅までの移動時間は、直線距離と80m/1分で算出しています。 ResultSet/Course/Line/timeOnBoardに移動時間のレスポンスを返します。

住所の指定方法

住所の文字列は、必ず都道府県から指定してください。また、少なくとも町・字までは必ず指定するようにしてください。


■OK例 町・字以降まで指定されている場合

東京都杉並区高円寺北


■NG例 市区町村までの場合

東京都杉並区


■NG例 郵便番号からの場合

〒166-8565 東京都杉並区高円寺北2-3-17


 Attention!

住所の文字列に、番地・号より詳細な情報(例えば、建物名など)が含まれる場合、そこまで含めて解釈されます。
この場合、住所の解釈が曖昧になり、意図した住所と変わってしまう、または住所が一意に定まらずにエラーになる可能性があるため、番地・号より詳細な情報は指定しないことをおすすめします。
なお、住所の解釈は、情報提供元の外部サービスの仕様に準じます。

住所の検索

指定された住所の文字列から住所を検索し、該当した住所への置き換えを行います。
住所の検索には、外部サービスを利用しています。詳しくは情報提供元をご確認ください。


  note

検索された住所については、レスポンスに含まれる住所の名称から確認することができます。
経路探索系に用いた場合、/ResultSet/Course/Route/Point/Nameに、検索された住所の名称が返ります(パラメーターに指定された住所の文字列ではありません。具体例については、レスポンス例をご参照ください)。
住所情報からの周辺駅検索に用いた場合、/ResultSet/Base/Point/Nameに、検索された住所の名称が返ります(パラメーターに指定された住所の文字列ではありません。具体例については、レスポンス例をご参照ください)。

住所の検索結果によっては、意図した住所とは異なる住所になる可能性がありますので、ご注意ください。

住所情報の指定パターン

住所情報の指定パターンは以下の2つとなります。

住所のみの指定

住所

半径を含めた指定

住所,半径

レスポンス例

東京都杉並区高円寺2-3-17から新宿駅までの経路を探索した場合

GET /v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=東京都杉並区高円寺北2-3-17,1000:新宿
<ResultSet apiVersion="1.27.0.0" engineVersion="201710_03a">
  <Course searchType="plain" dataType="plain">
    <Route timeOther="18" timeOnBoard="19" exhaustCO2="261" index="1" exhaustCO2atPassengerCar="1562" distance="93" timeWalk="7" transferCount="2">
      <Point index="1">
        <!-- Name要素は、パラメーターで指定された住所の文字列ではなく、文字列から検索された住所の名称になります。 -->
        <!-- 半径を含めた指定をした場合、住所の名称の後に「,」区切りで指定した半径が付きます。-->
        <Name>東京都杉並区高円寺北2丁目3−17,1000</Name>
      </Point>
      <Line direction="Down" stopStationCount="0" timeOnBoard="3" exhaustCO2="0" index="1" exhaustCO2atPassengerCar="0" distance="0">
        <ArrivalState>
          <Type>normal</Type>
          <Datetime operation="today">2017-10-19</Datetime>
        </ArrivalState>
        <Destination/>
        <TimeReliability>none</TimeReliability>
        <DepartureState>
          <Type>normal</Type>
          <Datetime operation="today">2017-10-19</Datetime>
        </DepartureState>
        <Color>000000000</Color>
      </Line>
      <Point index="2">
        <Station code="45643">
          <Name>高円寺中学校/関東バス</Name>
          <Type detail="local">bus</Type>
          <Yomi>こうえんじちゅうがっこう</Yomi>
        </Station>
        <Prefecture code="13">
          <Name>東京都</Name>
        </Prefecture>
        <GeoPoint longi="139.39.27.29" lati="35.42.13.19" longi_d="139.657582" gcs="tokyo" lati_d="35.703666"/>
      </Point>
        :
      <Point index="6">
        <Station code="22741">
          <Name>新宿</Name>
          <Type>train</Type>
          <Yomi>しんじゅく</Yomi>
        </Station>
        <Prefecture code="13">
          <Name>東京都</Name>
        </Prefecture>
        <GeoPoint longi="139.42.11.0" lati="35.41.15.0" longi_d="139.703056" gcs="tokyo" lati_d="35.6875"/>
      </Point>
    </Route>
        :
  </Course>
     :
</ResultSet>

関連URL