住所情報からの周辺駅検索
住所情報から駅の情報を取得します。半径を指定することで住所情報からの一定距離の駅を取得します。
GET /v1/{format}/address/station
parameters
※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。
Name | Type | Required | Description |
---|---|---|---|
format | string | ◯ | レスポンスのデータ形式の指定。必須 指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。 |
key | string | ◯ | アクセスキー。必須 |
address | string | ◯ | 住所情報。必須 |
type | string | --- | 駅の交通種別 。複数指定可。省略可。省略時は全ての交通種別が対象となります。 |
corporationBind | string | --- | 固定会社名。指定した会社のみ利用します。複数指定可。最大50件。省略可。省略時は制限のない通常の取得となります。 |
excludeSameLineStation | string | --- | 同一路線(乗り入れ路線が全て同じ)の駅を複数返さない。省略可。 指定できる値: - true: 同一路線の駅は1件のみとし、他は候補から除外する - false: 同一路線かどうかを考慮しない Default: false ※true指定時の検索結果は、最大10件となります。 |
stationCount | string | --- | 最大回答駅数。省略可。省略時およびstationCount=0を指定した時は検索結果全件となります。半径指定時のみ有効。 |
communityBus | string | --- | 取得結果の路線バスに対するコミュニティバスの扱いを指定します。type未指定時またはtypeにbusおよびbus.local指定時のみ有効。corporationBind 利用時には無効。省略可。 指定できる値: - contain:除外しない - except:除外する Default: contain |
gcs | string | --- | リクエストやレスポンスに座標が含まれる場合、座標の測地系を指定することができます。また、リクエストパラメータの座標情報はgcsパラメータとは別の測地系を個別に指定可能です。省略可。 指定できる値: - tokyo: 日本測地系 - wgs84: 世界測地系 Default: tokyo |
response
Name | Description |
---|---|
ResultSet / apiVersion | WebAPIバージョン |
ResultSet / engineVersion | エンジンバージョン |
ResultSet / Point / Distance | 指定した住所から駅までの直線距離 単位: メートル |
ResultSet / Point / GeoPoint / gcs | 測地系 |
ResultSet / Point / GeoPoint / lati | 緯度。度分秒(DMS)単位。秒は小数第3位を四捨五入。 Format: 度.分.秒.1/100秒 Example: 35.42.6.0 |
ResultSet / Point / GeoPoint / lati_d | 緯度。十進法度(DD)単位。 Format: 度 Example: 35.701667 |
ResultSet / Point / GeoPoint / longi | 経度。度分秒(DMS)単位。秒は小数第3位を四捨五入。 Format: 度.分.秒.1/100秒 Example: 139.38.22.30 |
ResultSet / Point / GeoPoint / longi_d | 経度。十進法度(DD)単位。 Format: 度 Example: 139.639527 |
ResultSet / Point / Prefecture / code | 都道府県コード |
ResultSet / Point / Prefecture / Name | 都道府県の名称 |
ResultSet / Point / Station / code | 駅コード |
ResultSet / Point / Station / Name | 駅の名称 |
ResultSet / Point / Station / Type | 交通種別 |
ResultSet / Point / Station / Type / detail | 交通種別の詳細。複数の場合は: 区切り。 |
ResultSet / Point / Station / Yomi | 読みかな |
ResultSet / Base / Point / Name | 指定した住所をAPIが解釈し、変換した住所 |
example
GET /v1/xml/address/station?address=東京都杉並区高円寺北2,500&key=アクセスキーを入力してください
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201706_01a">
<Point>
<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"/>
<Distance>211</Distance>
</Point>
<Point>
:
</Point>
<Base>
<Point>
<Name>東京都杉並区高円寺北2丁目</Name>
</Point>
</Base>
</ResultSet>
GET /v1/json/address/station?address=東京都杉並区高円寺北2,500&key=アクセスキーを入力してください
{
"ResultSet": {
"apiVersion": "1.27.0.0",
"engineVersion": "201706_01a",
"Point": [
{
"Station": {
"code": "45643",
"Name": "高円寺中学校/関東バス",
"Type": {
"text": "bus",
"detail": "local"
},
"Yomi": "こうえんじちゅうがっこう"
},
"Prefecture": {
"code": "13",
"Name": "東京都"
},
"GeoPoint": {
"longi": "139.39.27.29",
"lati": "35.42.13.19",
"longi_d": "139.657582",
"gcs": "tokyo",
"lati_d": "35.703666"
},
"Distance": "211"
},
{
:
},
{
"Base": {
"Point": {
"Name": "東京都杉並区高円寺北2丁目"
}
}
}
]
}
}