範囲探索

駅コード駅の名称で指定された鉄道駅を起点とし、上限値(分)の範囲内の鉄道駅を探索します。
起点となる鉄道駅は最大5件まで指定可能で、それぞれの起点に対して上限値を設定できます。複数の鉄道駅を指定した場合、各起点からの上限値(分)の範囲内に含まれる共通の鉄道駅を取得することができます。

GET /v1/{format}/search/multipleRange

parameters

※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。

Name Type Required Description
format string レスポンスのデータ形式の指定。必須
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
※クエリパラメータではなくパスに値を指定します。
key string アクセスキー 。必須
baseList string 駅コード駅の名称 のリスト。交通種別がtrainのもののみ指定可能です。必須。最大5件まで複数指定可。
詳しくはこちらを参照。
upperMinute int 起点駅からの所要時間の上限値。10から200まで指定可能です。
単位: 分
必須。複数指定可。baseListで指定した件数と一致する必要があります。
詳しくはこちらを参照。
upperTransferCount int --- 起点駅からの乗換回数の上限値。省略可。省略時は乗換回数を考慮しません。複数指定可。baseListで指定した件数と一致する必要があります。
詳しくはこちらを参照。
plane string --- 飛行機。省略可
指定できる値:
- true: 利用する
- false: 利用しない
Default: true
shinkansen string --- 新幹線(のぞみ含む)。省略可
指定できる値:
- true: 利用する
- false: 利用しない
Default: true
limitedExpress string --- 特急。省略可
指定できる値:
- true: 利用する
- false: 利用しない
Default: true
waitAverageTime string --- 出発駅での平均的な乗車待ち時間の設定。省略可
指定できる値:
- true: 出発駅での平均的な乗車待ち時間を含める
- false: 出発駅での平均的な乗車待ち時間を含めない
Default: true
limit int --- 探索結果項目の最大件数。省略可。省略時は全件を対象とします。
起点駅からの所要時間が少ない駅順に採用されます。
詳しくはこちらを参照。
date int --- 探索日付。省略可。
Format: YYYYMMDD
Default: 現在日付

baseList

baseListは駅コード駅の名称で指定します。
起点駅を複数指定した場合、各起点駅の範囲内に含まれる共通の鉄道駅のみを返します。

■例 複数の起点駅を駅コードで指定した場合
起点を新宿と東京にする場合、次のように指定します。

baseList=22741:22828

upperMinute

upperMinuteで指定する上限値の数はbaseListで指定した起点駅の数と一致する必要があり、 それぞれの上限値はbaseListで指定した起点駅の順に適用されます。

■例 複数の起点駅(baseList=A駅:B駅)に対して所要時間の上限値を指定する場合
一つ目の起点駅(A駅)の上限値を20分、二つ目の起点駅(B駅)の上限値を15分とする場合、次のように指定します。

upperMinute=20:15

Multiple range

upperTransferCount

upperTransferCountで指定する上限値の数はbaseListで指定した起点駅の数と一致させる必要があります。
また、一部の起点駅からの上限値を制限なしにすることもできます。 ただし、全ての起点駅からの上限値を制限なしにする場合は、パラメータ自体を省略してください。

■例 起点駅が3駅の場合の乗り換え回数の上限値の指定方法

1駅目 2駅目 3駅目 パラメータ値
2 1 3 upperTransferCount=2:1:3
0 制限なし 1 upperTransferCount=0::1
制限なし 0 制限なし upperTransferCount=:0:
制限なし 制限なし 制限なし パラメータを省略。詳細はこちら(複数指定)。

limit

limitを指定した場合は、起点駅からの所要時間が少ない駅順に採用されます。
また、複数の起点駅を指定した場合は、各起点駅からの所要時間のうち、一番短い値が比較対象となります。

■例. 2つの起点駅を指定してlimitを3とした場合

所要時間が以下の場合、所要時間の最小値が比較されるため、A駅、C駅、B駅が返ります。

  • A駅までは2分と10分
  • B駅までは5分と5分
  • C駅までは8分と3分
  • D駅までは10分と6分
  • E駅までは8分と10分


response

Name Description
ResultSet レスポンスの最下部を表す要素
ResultSet / apiVersion WebAPIバージョン
ResultSet / engineVersion エンジンバージョン
ResultSet / Base 起点を表すリスト
ResultSet / Base / index インデックス。
※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項
ResultSet / Base / Point 起点となる地点を表す要素
ResultSet / Base / Point / Station 駅を表す要素
ResultSet / Base / Point / Station / code 駅コード
ResultSet / Base / Point / Station / Name 駅の名称を表す要素
ResultSet / Base / Point / Station / Type 交通種別を表す要素
ResultSet / Base / Point / Prefecture 都道府県を表す要素
ResultSet / Base / Point / Prefecture / code 都道府県コード
ResultSet / Base / Point / Prefecture / Name 都道府県の名称を表す要素
ResultSet / Point 地点を表す要素
ResultSet / Point / Cost 起点駅毎の所要時間や乗換回数を表す要素
ResultSet / Point / Cost / baseIndex ResultSet / Base / indexと紐づくインデックス
ResultSet / Point / Cost / Minute 起点からの時間を表す要素
単位: 分
ResultSet / Point / Cost / TransferCount 起点からの乗換回数を表す要素
ResultSet / Point / Prefecture 都道府県を表す要素
ResultSet / Point / Prefecture / code 都道府県コード
ResultSet / Point / Prefecture / Name 都道府県の名称を表す要素
ResultSet / Point / Station / code 駅コード
ResultSet / Point / Station / Name 駅の名称を表す要素
ResultSet / Point / Station / Type 交通種別を表す要素

example

GET /v1/xml/search/multipleRange?key=アクセスキーを入力してください&baseList=22828&upperMinute=15
<ResultSet apiVersion="1.27.0.0" engineVersion="201708_01a">
  <Point>
    <Station code="23036">
      <Name>有楽町</Name>
      <Type>train</Type>
    </Station>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Cost baseIndex="1">
      <Minute>5</Minute>
      <TransferCount>0</TransferCount>
    </Cost>
  </Point>
  <Point>
    <Station code="22617">
      <Name>神田(東京都)</Name>
      <Type>train</Type>
    </Station>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Cost baseIndex="1">
      <Minute>5</Minute>
      <TransferCount>0</TransferCount>
    </Cost>
  </Point>
  <Point>
    <Station code="22492">
      <Name>秋葉原</Name>
      <Type>train</Type>
    </Station>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Cost baseIndex="1">
      <Minute>7</Minute>
      <TransferCount>0</TransferCount>
    </Cost>
  </Point>
  <Point>
    <Station code="22751">
      <Name>新橋</Name>
      <Type>train</Type>
    </Station>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Cost baseIndex="1">
      <Minute>8</Minute>
      <TransferCount>0</TransferCount>
    </Cost>
  </Point>
  <Point>
    <Station code="22914">
      <Name>浜松町</Name>
      <Type>train</Type>
    </Station>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Cost baseIndex="1">
      <Minute>9</Minute>
      <TransferCount>0</TransferCount>
    </Cost>
  </Point>
  <Point>
    <Station code="22570">
      <Name>御徒町</Name>
      <Type>train</Type>
    </Station>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Cost baseIndex="1">
      <Minute>9</Minute>
      <TransferCount>0</TransferCount>
    </Cost>
  </Point>
  :
  <Base index="1">
    <Point>
      <Station code="22828">
        <Name>東京</Name>
        <Type>train</Type>
      </Station>
      <Prefecture code="13">
        <Name>東京都</Name>
      </Prefecture>
    </Point>
  </Base>
</ResultSet>
GET /v1/json/search/multipleRange?key=アクセスキーを入力してください&baseList=22828&upperMinute=15
{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "engineVersion": "201708_01a",
    "Point": [
      {
        "Station": {
          "code": "23036",
          "Name": "有楽町",
          "Type": "train"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Cost": {
          "baseIndex": "1",
          "Minute": "5",
          "TransferCount": "0"
        }
      },
      {
        "Station": {
          "code": "22617",
          "Name": "神田(東京都)",
          "Type": "train"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Cost": {
          "baseIndex": "1",
          "Minute": "5",
          "TransferCount": "0"
        }
      },
      {
        "Station": {
          "code": "22492",
          "Name": "秋葉原",
          "Type": "train"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Cost": {
          "baseIndex": "1",
          "Minute": "7",
          "TransferCount": "0"
        }
      },
      {
        "Station": {
          "code": "22751",
          "Name": "新橋",
          "Type": "train"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Cost": {
          "baseIndex": "1",
          "Minute": "8",
          "TransferCount": "0"
        }
      },
      {
        "Station": {
          "code": "22914",
          "Name": "浜松町",
          "Type": "train"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Cost": {
          "baseIndex": "1",
          "Minute": "9",
          "TransferCount": "0"
        }
      },
      {
        "Station": {
          "code": "22570",
          "Name": "御徒町",
          "Type": "train"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Cost": {
          "baseIndex": "1",
          "Minute": "9",
          "TransferCount": "0"
        }
      },
      {
          :
      }
    ]
    "Base": {
      "Point": {
        "Station": {
          "code": "22828",
          "Name": "東京",
          "Type": "train"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        }
      }
    }
  }
}
ページ上部へ