コンテンツにスキップ

駅/バス停ID検索

/transport_node/id [GET]

基本情報

概要

駅・バス停のIDを指定して駅・バス停の情報を取得します。

URL

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

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

出力形式

  • JSON

対応言語

  • ja

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
id ノードID 文字列 ピリオド区切りで複数指定できます
options 追加出力情報 文字列 detail:駅・バス停の詳細情報
bus_data バスデータ利用情報 文字列 timetable:バスデータを利用するかどうかのフラグ バス停の情報取得は、オプション機能のため、別途契約が必要となります
(APIマーケットでは利用不可)
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

パラメータ構成例

  • 駅ID「00005077」の駅情報を取得
/transport_node/id?id=00005077
  • 駅ID「00005077」の駅情報を取得(詳細情報付き)
/transport_node/id?id=00005077&options=detail

レスポンス

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

Nodeオブジェクト

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

Coordinateオブジェクト

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

NodeDetailオブジェクト

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

Companyオブジェクト

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

NodePoiオブジェクト

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

Numberingオブジェクト

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

ExactCoordinateオブジェクト

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

SubLinkNameオブジェクト

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

DirectionListオブジェクト

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

Directionオブジェクト

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

Unitオブジェクト

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

レスポンス例

{
    "items": [
        {
            "id": "00004254",
            "name": "新宿",
            "ruby": "しんじゅく",
            "types": [
                "station"
            ],
            "address_name": "東京都新宿区新宿",
            "address_code": "13104046000",
            "coord": {
                "lat": 35.689575,
                "lon": 139.700685
            },
            "details": [
                {
                    "company": {
                        "id": "00000004",
                        "name": "JR東日本"
                    },
                    "companies": [
                        {
                            "id": "00000004",
                            "name": "JR東日本"
                        }
                    ],
                    "poi": {
                        "name": "新宿",
                        "ruby": "しんじゅく",
                        "type": "station",
                        "address_name": "東京都新宿区新宿",
                        "address_code": "13104046000",
                        "coord": {
                            "lat": 35.689575,
                            "lon": 139.700685
                        },
                        "numbering": [
                            {
                                "symbol": "JA",
                                "number": "11"
                            }
                        ],
                        "exact_coord": {
                            "up": {
                                "lat": 35.689575,
                                "lon": 139.700685
                            },
                            "down": {
                                "lat": 35.689575,
                                "lon": 139.700685
                            }
                        }
                    },
                    "link": {
                        "id": "00000139",
                        "name": "JR埼京線",
                        "color": "#00B48D",
                        "sub_link": {
                            "up": {
                                "name": "りんかい線"
                            },
                            "down": {
                                "name": "JR川越線"
                            }
                        }
                    }
                },
                ・・・
            ]
        }
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス エラーメッセージ 発生理由
405 This http method is invalid : POST (等) 許可されていないHTTPメソッドでアクセスされた場合に発生します。
400 parameter error: id: ['required field'] 必須パラメータである id が指定されていない、または空文字の場合に発生します。
400 parameter error: id: ['an invalid code: {value}'] id にピリオド区切りで不正なノードIDを指定した場合に発生します。
400 parameter error: options: ['unallowed value {value}'] options に detail 以外の不正な値を指定した場合に発生します。
400 parameter error: bus_data: ['unallowed value {value}'] bus_data に timetable 以外の不正な値を指定した場合に発生します。
400 parameter error: datum: ['unallowed value {value}'] datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。
400 parameter error: coord_unit: ['unallowed value {value}'] coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。
400 bad usage on this contract : bus_data bus_data を指定したが、契約でバスデータ利用オプションが有効化されていない場合に発生します。
400 bad usage on this contract : use_company and unuse_company must be either. 契約の運行会社設定に不整合がある場合に発生します。