平均路線情報

「駅すぱあと」の保持する平均路線の情報を取得します。 nameを指定すると、名称の前方一致による絞り込みを行います。 oldNameを指定すると、新名称を取得できます。 fromとtoを指定した場合は、2点間を結ぶ平均路線が取得できます。 dateを指定すると、その日に運行している平均路線に絞り込めます。 serializeDataとsectionIndexを指定すると、区間の列車リストを取得できます。

GET /v1/{format}/rail

parameters

Name Type Description
format string レスポンスのデータ形式の指定。必須。
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
key string アクセスキー。必須
name string 平均路線の名称(前方一致)。oldName, corporationName, from, to, serializeDataと排他。省略可
oldName string 平均路線の旧名称。name, corporationName, from, to, serializeDataと排他。省略可
corporationCode int 会社コード。name, oldName, corporationName, from, to, serializeDataと排他。省略可
corporationName string 会社の名称。name, oldName, corporationCode, from, to, serializeDataと排他。省略可
from string 駅コードまたは駅の名称。name, oldName, corporationName, serializeDataと排他。to指定時に必須
to string 駅コードまたは駅の名称。name, oldName, corporationName, serializeDataと排他。from指定時に必須
prefectureCode int 都道府県コード。省略可。省略時は全国が対象となります。
date int 日付。省略可。省略時は全日付が対象となります。
Format: YYYYMMDD
type string 交通種別詳細路線種別を付加することができます。省略可。省略時は全種別が対象となります。
offset int データの取得開始位置。name, serializeData指定時は無効となります。省略可。
Default: 1
limit int データのブロック件数。最大100件まで指定できます。name, serializeData指定時は無効となります。省略可。
Default: 100
serializeData string 経路シリアライズデータ。name, oldName, corporationName, from, toと排他。省略可
checkEngineVersion string 完全な経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。
指定できる値:
- true: チェックする
- false: チェックしない
Default: true
sectionIndex int 区間インデックス。serializeData指定時に必須

response

Name Description
ResultSet レスポンスの最下部を表す要素
ResultSet / apiVersion WebAPIバージョン
ResultSet / engineVersion エンジンバージョン
ResultSet / max データの取得件数。一度に全件取得できない場合は、offsetの指定を繰り上げて取得してください。
ResultSet / offset データ開始位置のオフセット値
ResultSet / Corporation 会社を表す要素
ResultSet / Corporation / code 会社コード
ResultSet / Corporation / Name 会社の名称を表す要素
ResultSet / Corporation / index インデックス
※ jsonデータ形式のレスポンスにインデックスは含まれません。jsonにおけるindexの扱い
ResultSet / Line 区間 を表す要素
ResultSet / Line / code 短期的な利用を前提とした列車コード
ResultSet / Line / corporationIndex ResultSet / Corporation / indexと紐づくインデックス
ResultSet / Line / ArrivalState 到着時の状態を表す要素
ResultSet / Line / ArrivalState / no 到着番線、番号等
ResultSet / Line / ArrivalState / Datetime 日時を表す要素
ResultSet / Line / ArrivalState / Datetime / operation 運行日判定
- today: 日時通り
- yesterday: 前日
ResultSet / Line / DepartureState 出発時の状態を表す要素
ResultSet / Line / DepartureState / no 出発番線、番号等
ResultSet / Line / DepartureState / Datetime 日時を表す要素
ResultSet / Line / DepartureState / Datetime / operation 運行日判定
- today: 日時通り
- yesterday: 前日
ResultSet / Line / Name 名称を表す要素
ResultSet / Line / Number 番号(号、便など)を表す要素
ResultSet / Line / OldName 旧名称を表す要素
ResultSet / Line / Type 交通種別を表す要素
ResultSet / Line / Type / detail 交通種別の詳細または詳細路線種別
ResultSet / Line / Color 色を表す要素

example

会社を指定して平均路線一覧を取得する

GET /v1/xml/rail?key=アクセスキーを入力してください&corporationName=JR
<ResultSet apiVersion="1.27.0.0" max="447" offset="1" engineVersion="201608_03a">
  <Corporation index="1" code="1">
    <Name>JR</Name>
  </Corporation>
  <Line corporationIndex="1">
    <Name>JR新幹線のぞみ</Name>
    <Type detail="shinkansen">train</Type>
    <Color>051102255</Color>
  </Line>
  <Line corporationIndex="1">
    <Name>JR新幹線ひかり(東京-博多)</Name>
    <Type detail="shinkansen">train</Type>
    <Color>001044255</Color>
  </Line>
  <Line corporationIndex="1">
    <Name>JR新幹線こだま(東京-新大阪)</Name>
    <Type detail="shinkansen">train</Type>
    <Color>001044255</Color>
  </Line>
  <Line corporationIndex="1">
    <Name>JR新幹線こだま(新大阪-博多)</Name>
    <Type detail="shinkansen">train</Type>
    <Color>001044255</Color>
  </Line>
  <Line corporationIndex="1">
    <Name>JR新幹線はやぶさ</Name>
    <Type detail="shinkansen">train</Type>
    <Color>000208030</Color>
  </Line>
  :
  </Line>
</ResultSet>
GET /v1/json/rail?key=アクセスキーを入力してください&corporationName=JR
{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "max": "447",
    "offset": "1",
    "engineVersion": "201608_03a",
    "Corporation": {
        "code": "1",
        "Name": "JR"
    },
    "Line": [
      {
        "corporationIndex": "1",
        "Name": "JR新幹線のぞみ",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "051102255"
      },
      {
        "corporationIndex": "1",
        "Name": "JR新幹線ひかり(東京-博多)",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "001044255"
      },
      {
        "corporationIndex": "1",
        "Name": "JR新幹線こだま(東京-新大阪)",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "001044255"
      },
      {
        "corporationIndex": "1",
        "Name": "JR新幹線こだま(新大阪-博多)",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "001044255"
      },
      {
        "corporationIndex": "1",
        "Name": "JR新幹線はやぶさ",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "000208030"
      },
      {
        :
      }
    ]
  }
}

旧名称から新名称を取得する

GET /v1/xml/rail?key=アクセスキーを入力してください&oldName=近鉄奈良線快急
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Line>
    <Name>近鉄奈良線快速急行</Name>
    <OldName>近鉄奈良線快急</OldName>
  </Line>
</ResultSet>
GET /v1/json/rail?key=アクセスキーを入力してください&oldName=近鉄奈良線快急
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Line": {
      "Name": "近鉄奈良線快速急行",
      "OldName": "近鉄奈良線快急"
    }
  }
}

経路シリアライズデータから列車のリストを取得する

GET /v1/xml/rail?key=アクセスキーを入力してください&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041&sectionIndex=1
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Line code="Both:0">
    <Name>JR中央線・東京行</Name>
    <Type>train</Type>
    <Color>250060002</Color>
    <DepartureState no="2">
      <Datetime operation="today">04:43:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">04:53:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Line code="Both:1">
    <Name>JR中央線・東京行</Name>
    <Type>train</Type>
    <Color>250060002</Color>
    <DepartureState no="2">
      <Datetime operation="today">04:51:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">05:02:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Line code="Both:2">
    <Name>JR中央線・東京行</Name>
    <Type>train</Type>
    <Color>250060002</Color>
    <DepartureState no="2">
      <Datetime operation="today">05:04:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">05:13:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Line code="Both:3">
    <Name>JR総武線・千葉行</Name>
    <Type>train</Type>
    <Color>255222000</Color>
    <DepartureState no="2">
      <Datetime operation="today">05:07:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">05:16:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Line code="Both:4">
    <Name>JR中央線・東京行</Name>
    <Type>train</Type>
    <Color>250060002</Color>
    <DepartureState no="2">
      <Datetime operation="today">05:14:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">05:23:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Line>
  :
  </Line>
</ResultSet>
GET /v1/json/rail?key=アクセスキーを入力してください&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041&sectionIndex=1
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Line": [
      {
        "code": "Both:0",
        "Name": "JR中央線・東京行",
        "Type": "train",
        "Color": "250060002",
        "DepartureState": {
          "no": "2",
          "Datetime": {
            "text": "04:43:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "04:53:00+09:00",
            "operation": "today"
          }
        }
      },
      {
        "code": "Both:1",
        "Name": "JR中央線・東京行",
        "Type": "train",
        "Color": "250060002",
        "DepartureState": {
          "no": "2",
          "Datetime": {
            "text": "04:51:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "05:02:00+09:00",
            "operation": "today"
          }
        }
      },
      {
        "code": "Both:2",
        "Name": "JR中央線・東京行",
        "Type": "train",
        "Color": "250060002",
        "DepartureState": {
          "no": "2",
          "Datetime": {
            "text": "05:04:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "05:13:00+09:00",
            "operation": "today"
          }
        }
      },
      {
        "code": "Both:3",
        "Name": "JR総武線・千葉行",
        "Type": "train",
        "Color": "255222000",
        "DepartureState": {
          "no": "2",
          "Datetime": {
            "text": "05:07:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "05:16:00+09:00",
            "operation": "today"
          }
        }
      },
      {
        "code": "Both:4",
        "Name": "JR中央線・東京行",
        "Type": "train",
        "Color": "250060002",
        "DepartureState": {
          "no": "2",
          "Datetime": {
            "text": "05:14:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "05:23:00+09:00",
            "operation": "today"
          }
        }
      },
      {
        :
      }
    ]
  }
}