コンテンツにスキップ

駅/バス停名検索

/transport_node [GET]

基本情報

概要

キーワードや住所など、条件に該当する駅・バス停の一覧を取得します。

URL

https://{HOST}/{CID}/v1/transport_node

※APIマーケットの場合はURL体系が異なります

出力形式

  • JSON

対応言語

  • ja

出力順

  • キーワードの類似度と検索のランキングを考慮したスコア降順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
word 検索ワード 文字列 複数指定時はAND条件、OR条件の順で検索します
51文字以降は切り捨てます
address 住所コード 文字列 ピリオド区切りで複数指定できます
type 出力する交通機関 文字列 交通機関タイプより指定 ピリオド区切りで複数指定できます
出力する駅・バス停種別を限定したい場合にご利用ください(未指定の場合は全種別が検索されます)

バス停の情報取得は、オプション機能のため、別途契約が必要となります
(APIマーケットでは利用不可)
options 追加出力情報 文字列 detail:駅・バス停の詳細情報
offset データの出力開始位置 数値 0 最小値:0
最大値:1000
何件目から表示されるか(1件目が0)を指定します
limit データの出力件数 数値 10 最小値:1
最大値:100
駅・バス停データの出力件数
bus_data バスデータ利用情報 文字列 timetable:バスデータを利用するかどうかのフラグ バス停の情報取得は、オプション機能のため、別途契約が必要となります
(APIマーケットでは利用不可)
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

type(交通機関タイプ)

'type' は以下の文字列を取り得ます。

文字列 概要 備考
station 鉄道駅
airport 空港
port
busstop 路線バスのバス停 バス停の情報取得は、オプション機能のため、別途契約が必要となります
(APIマーケットでは利用不可)
shuttle_busstop 空港連絡バスのバス停
highway_busstop 高速バスのバス停 バス停の情報取得は、オプション機能のため、別途契約が必要となります
(APIマーケットでは利用不可)

パラメータ構成例

  • 検索ワード「赤坂」で10件検索
/transport_node?word=赤坂
  • 検索ワード「代々木」で10件検索(詳細情報付き)
/transport_node?word=代々木&options=detail
  • 検索ワード「成田」で鉄道駅を10件検索
/transport_node?word=成田&type=station

レスポンス

名称 レスポンス名 型名 配列 説明
検索数 count Countオブジェクト
駅・バス停情報 items Nodeオブジェクト
単位情報 unit Unitオブジェクト 出力される単位の情報

Countオブジェクト

名称 レスポンス名 型名 配列 説明
トータルヒット件数 total 数値 検索ヒットした件数
オフセット値 offset 数値 オフセットが設定されている場合はその値を出力
データの出力件数 limit 数値 データの出力件数に設定されている値
1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力

Nodeオブジェクト

名称 レスポンス名 型名 配列 説明
駅/バス停のノードID id 文字列
駅/バス停の名称 name 文字列
駅/バス停の名称の読み仮名 ruby 文字列
ノードタイプの一覧 types 文字列
住所の表示名 address_name 文字列
住所コード address_code 文字列
駅/バス停の代表緯度経度 coord Coordinateオブジェクト 株式会社ナビタイムジャパンが独自で算出しています
駅/バス停の詳細情報 details NodeDetail オブジェクト

Coordinateオブジェクト

名称 レスポンス名 型名 配列 説明
緯度 lat 数値
経度 lon 数値

NodeDetailオブジェクト

名称 レスポンス名 型名 配列 説明
運行会社情報 company Companyオブジェクト
会社情報 companies Companyオブジェクト
ノード情報 poi NodePoiオブジェクト
路線情報 link Linkオブジェクト

Companyオブジェクト

名称 レスポンス名 型名 配列 説明
運行会社ID id 文字列
運行会社の名称 name 文字列

NodePoiオブジェクト

名称 レスポンス名 型名 配列 説明
駅/バス停の名称 name 文字列
駅/バス停の名称の読み仮名 ruby 文字列
ノードタイプ type 文字列
住所の表示名 address_name 文字列
住所コード address_code 文字列
駅/バス停の代表緯度経度 coord Coordinateオブジェクト 株式会社ナビタイムジャパンが独自で算出しています
駅ナンバリング情報 numbering Numberingオブジェクト
駅/バス停の詳細緯度経度 exact_coord ExactCoordinateオブジェクト

Numberingオブジェクト

名称 レスポンス名 型名 配列 説明
駅シンボル記号 symbol 文字列
駅番号 number 文字列

ExactCoordinateオブジェクト

名称 レスポンス名 型名 配列 説明
上り線のノードの詳細緯度経度 up Coordinateオブジェクト
下り線のノードの詳細緯度経度 down Coordinateオブジェクト
名称 レスポンス名 型名 配列 説明
実路線の ID id 文字列
実路線の名称 name 文字列
実路線の推奨色 color 文字列
副実路線情報 sub_link SubLinkオブジェクト
方面情報 direction_list DirectionListオブジェクト
名称 レスポンス名 型名 配列 説明
上り方面の副実路線名 up SubLinkNameオブジェクト
下り方面の副実路線名 down SubLinkNameオブジェクト

SubLinkNameオブジェクト

名称 レスポンス名 型名 配列 説明
副実路線名 name 文字列

DirectionListオブジェクト

名称 レスポンス名 型名 配列 説明
下り方面情報 down Directionオブジェクト
上り方面情報 up Directionオブジェクト

Directionオブジェクト

名称 レスポンス名 型名 配列 説明
駅/バス停のノードID id 文字列
駅/バス停の名称 name 文字列

Unitオブジェクト

名称 レスポンス名 型名 配列 説明
測地系 datum 文字列
緯度経度の出力形式 coord_unit 文字列

レスポンス例

{
    "count": {
        "total": 19,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "id": "00005506",
            "name": "代々木",
            "ruby": "よよぎ",
            "types": [
                "station"
            ],
            "address_name": "東京都渋谷区千駄ヶ谷",
            "address_code": "13113017000",
            "coord": {
                "lat": 35.683593,
                "lon": 139.702197
            },
            "details": [
                {
                    "company": {
                        "id": "00000004",
                        "name": "JR東日本"
                    },
                    "companies": [
                        {
                            "id": "00000004",
                            "name": "JR東日本"
                        }
                    ],
                    "poi": {
                        "name": "代々木",
                        "ruby": "よよぎ",
                        "type": "station",
                        "address_name": "東京都渋谷区千駄ヶ谷",
                        "address_code": "13113017000",
                        "coord": {
                            "lat": 35.683593,
                            "lon": 139.702197
                        },
                        "numbering": [
                            {
                                "symbol": "JY",
                                "number": "18"
                            }
                        ],
                        "exact_coord": {
                            "up": {
                                "lat": 35.683593,
                                "lon": 139.702197
                            },
                            "down": {
                                "lat": 35.683593,
                                "lon": 139.702197
                            }
                        }
                    },
                    "link": {
                        "id": "00000141",
                        "name": "JR山手線"
                    }
                },
                ・・・
            ]
        },
        ・・・
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}