駅簡易情報

指定された条件に当てはまる駅の簡易情報を返します。

このAPIは主に候補駅の確定を想定しているため、必要最低限の簡易データのみ返します。また、一度に取得できる最大件数は30件です。候補駅の確定(インクリメンタルサーチ)などで利用される場合、アクセスの回数は最大2回/1秒程度を目安にご利用ください。

GET /v1/{format}/station/light

parameters

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

Name	Type	Required	Description
format	string	◯	レスポンスのデータ形式の指定。必須指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。
key	string	◯	アクセスキーの指定。必須
name	string	---	候補文字列。codeと排他。かつ省略可なため、codeが存在しない場合はname扱いとなります。
nameMatchType	string	---	nameのマッチング方式の指定。nameパラメータ指定時のみ有効。省略可。指定できる値: - forward : 前方一致 - partial : 部分一致 Default: forward ※部分一致の場合、名称の末尾に付く括弧内の補足情報はマッチング対象外となります。（例: 「中野(東京都)」の`(東京都)`部分）
code	int	---	駅コード。nameと排他。
type	string	---	駅の交通種別。複数指定可。省略可。省略時は指定なしとなります。指定できる値: - train: 鉄道 - plane: 航空
prefectureCode	string	---	都道府県コード。code利用時には無効です。複数指定可。省略可。省略時は全国が対象となります。
corporationBind	string	---	固定会社名。指定した会社のみ利用します。複数指定可。最大50件。省略可。省略時は制限のない通常の取得となります。
gcs	string	---	レスポンスに座標が含まれる場合、座標の測地系を指定することができます。省略可。指定できる値: - tokyo: 日本測地系 - wgs84: 世界測地系 Default: tokyo

response

Name	Description
ResultSet	レスポンスの最下部を表す要素
ResultSet / apiVersion	WebAPIバージョン
ResultSet / engineVersion	エンジンバージョン
ResultSet / Point	地点を表す要素
ResultSet / Point / Prefecture	都道府県を表す要素
ResultSet / Point / Prefecture / code	都道府県コード
ResultSet / Point / Prefecture / Name	都道府県の名称
ResultSet / Point / Station	駅を表す要素
ResultSet / Point / Station / code	駅コード
ResultSet / Point / Station / Name	駅の名称
ResultSet / Point / Station / Type	交通種別 - train: 鉄道 - plane: 航空
ResultSet / Point / Station / Type / detail	交通種別の詳細。複数の場合は`:`区切り。
ResultSet / Point / Station / Yomi	読みかな

example

GET /v1/xml/station/light?key=アクセスキーを入力してください&name=東京

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201612_02a">
    <Point>
        <Station code="22828">
            <Name>東京</Name>
            <Type>train</Type>
            <Yomi>とうきょう</Yomi>
        </Station>
        <Prefecture code="13">
            <Name>東京都</Name>
        </Prefecture>
    </Point>
    <Point>
        <Station code="29110">
            <Name>成田空港(東京)</Name>
            <Type>plane</Type>
            <Yomi>なりたくうこう</Yomi>
        </Station>
        <Prefecture code="12">
            <Name>千葉県</Name>
        </Prefecture>
    </Point>
    <Point>
        <Station code="22827">
            <Name>羽田空港(東京)</Name>
            <Type>plane</Type>
            <Yomi>はねだくうこう</Yomi>
        </Station>
        <Prefecture code="13">
            <Name>東京都</Name>
        </Prefecture>
    </Point>
    <Point>
        <Station code="22859">
            <Name>とうきょうスカイツリー</Name>
            <Type>train</Type>
            <Yomi>とうきょうすかいつりー</Yomi>
        </Station>
        <Prefecture code="13">
            <Name>東京都</Name>
        </Prefecture>
    </Point>
    <Point>
        :
    </Point>
</ResultSet>

GET /v1/json/station/light?key=アクセスキーを入力してください&name=東京

{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "engineVersion": "201612_02a",
    "Point": [
      {
        "Station": {
          "code": "22828",
          "Name": "東京",
          "Type": "train",
          "Yomi": "とうきょう"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        }
      },
      {
        "Station": {
          "code": "29110",
          "Name": "成田空港(東京)",
          "Type": "plane",
          "Yomi": "なりたくうこう"
        },
        "Prefecture": {
          "code": "12",
          "Name": "千葉県"
        }
      },
      {
        "Station": {
          "code": "22827",
          "Name": "羽田空港(東京)",
          "Type": "plane",
          "Yomi": "はねだくうこう"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        }
      },
      {
        "Station": {
          "code": "22859",
          "Name": "とうきょうスカイツリー",
          "Type": "train",
          "Yomi": "とうきょうすかいつりー"
        },
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        }
      },
      {
        :
      }
    ]
  }
}