Station information


 Attention!

This page has not been fully translated into English yet. It is possible that some parts of description may contains old information. Please see Japanese Documents if you need the latest and accurate information.

Returns information on the station that satisfies the specified conditions.

GET /v1/{format}/station

parameters

Name Type Description
format string Specifying the response data format. Required.
Possible values:
- xml: xml format data
- json: json format data.
key string Your access key. Required.
name string Candidate text example. Exclusive with oldName, code, corporationName, railName, operationLineCode. As this can also be omitted, where the exclusion parameter does not exist, name Optional.
oldName string Former station name. name, code, corporationName, railName, operationLineCode are excluded.
*Does not apply to Bus Stop or Port Names.
code int station code. name, oldName, corporationName, railName, operationLineCode are excluded.
corporationName string corporation name. code, railName, operationLineCode are excluded.
railName string Ekispert average rail name. name, code, corporationName, operationLineCode are excluded.
operationLineCode string operation line code. name, oldName, code, corporationName, railName are excluded.
type string Station line's transport type . Does not operate when oldName, code, corporationName, railName, operationLineCode are in use. multiple specifications may be used. Optional. When omitted there is no specification.
prefectureCode int prefecture code. Optional. multiple specifications possible. Does not function when oldName, code, railName, or operationLineCode are specified. Applies to entire country when omitted.
offset int Data acquisition start position. Optional. oldName, code, railName, operationLineCode time specification cannot be used.
Default: 1
limit int number of data blocks. Optional. Does not function when oldName, code, railName, or operationLineCode are specified. Maximum of 100
Default: 100
direction string Direction of stops along the route. Only operates when railName, operationLineCode are specified.
Possible Values:
- up: Normal
- down: Opposite
- none: None
Default: up
corporationBind string Fixed corporation name. Specified corporation only can be used. multiple specifications is possible. You can pass in a maximum of 50 values. Can be abbreviated. When omitted, because normal unlimited acquisition.
addGateGroup string Add information about grouped exits in the Station elements. Optional.
Possible values:
- true: add information about grouped exits
- false: not add information about grouped exits
Default: false
communityBus string 取得結果の路線バスに対するコミュニティバスの扱いを指定します。
type未指定時またはtypeにbusおよびbus.local指定時のみ有効。oldName, code, corporationName, railName, operationLineCode, corporationBind 利用時には無効。省略可。
指定できる値:
- contain:除外しない
- except:除外する
Default: contain
gcs string If the request and response include coordinates, the geodetic system for the coordinates can be specified. coordinate information of the request parameters can be set separately from this parameter. Optional.
Possible values:
- tokyo: Tokyo Geodetic System
- wgs84: World Geodetic System
Default: tokyo

response

Name Description
ResultSet / apiVersion Web API version
ResultSet / engineVersion Engine version
ResultSet / max Total number of entries. If it cannot be acquired all at once, please assign an offset and acquire with multiple requests.
ResultSet / offset Start position for data offset
ResultSet / Point Elements to represent points
ResultSet / Point / index Index.
*Responses in json format do not include an index. index handling on json response
*Can be added when railName is specified
ResultSet / Point / getOn Embarkation possible flag.
- true: Possible
- false: Not possible
*Available when railName has been specified
ResultSet / Point / getOff Disembarkation flag.
- true: possible
- false: not possible
* Can be added when railName is specified.
ResultSet / Point / onRoute Flag between zones.
- true: Within target route zone
- false: outside zone
※ added when designating railName
ResultSet / Point / onRouteEdge Section end flag.
- true: End of target route.
- false: Outside of edge.
* Can be added when railName is set.
ResultSet / Point / GeoPoint Elements to display coordinates
ResultSet / Point / GeoPoint / lati Latitude in degrees minutes seconds (DMS) format. The numbers of seconds are rounded to the third decimal place.
Format: degrees.minutes.seconds.hundredths of a second
Example: 35.42.6.0
ResultSet / Point / GeoPoint / lati_d Latitude in decimal degrees (DD) format.
Format: decimal degrees
Example: 35.701667
ResultSet / Point / GeoPoint / longi Longitude in degrees minutes seconds (DMS) format. The numbers of seconds are rounded to the third decimal place.
Format: degrees.minutes.seconds.hundredths of a second
Example: 139.38.22.30
ResultSet / Point / GeoPoint / longi_d Longitude in decimal degrees (DD) format.
Format: decimal degrees
Example: 139.639527
ResultSet / Point / GeoPoint / gcs Geodetic System
ResultSet / Point / Prefecture Elements to display prefecture
ResultSet / Point / Prefecture / code prefecture code
ResultSet / Point / Prefecture / Name Prefecture Name
ResultSet / Point / Station Elements to display station
ResultSet / Point / Station / code station code
ResultSet / Point / Station / Name Elements to display station name
ResultSet / Point / Station / OldName Elements to display old name.
*Can be used when oldName is specified
ResultSet / Point / Station / Type Elements to display transport type
ResultSet / Point / Station / Type / detail transport type details. Separate with : when there are multiple entries.
ResultSet / Point / Station / Yomi Elements to display station
ResultSet / Point / Station / GateGroup / Elements to display grouped exits
ResultSet / Point / Station / GateGroup / Gate Elements to display exit
ResultSet / Point / Station / GateGroup / Gate / code Elements to display exit code
ResultSet / Point / Station / GateGroup / Gate / Name Elements to display name of exit
ResultSet / Point / Station / GateGroup / Gate / GeoPoint Elements to display coordinates
ResultSet / Point / station / GateGroup / Gate / GeoPoint / lati Latitude in degrees minutes seconds (DMS) format. The numbers of seconds are rounded to the third decimal place.
Format: degrees.minutes.seconds.hundredths of a second
Example: 35.42.6.0
ResultSet / Point / station / GateGroup / Gate / GeoPoint / lati_d Latitude in decimal degrees (DD) format.
Format: decimal degrees
Example: 35.701667
ResultSet / Point / station / GateGroup / Gate / GeoPoint / longi Longitude in degrees minutes seconds (DMS) format. The numbers of seconds are rounded to the third decimal place.
Format: degrees.minutes.seconds.hundredths of a second
Example: 139.38.22.30
ResultSet / Point / station / GateGroup / Gate / GeoPoint / longi_d Longitude in decimal degrees (DD) format.
Format: decimal degrees
Example: 139.639527
ResultSet / Point / Station / GateGroup / Gate / GeoPoint / gcs Geodetic System
ResultSet / RoundTripType Elements to display round trip types. Can only be added when railName is specified.
- same: Round trip passes through the same stations.
- different: Round trip passes through different stations
- none: No stops for this round trip(Discontinued route, etc.)
- other: When same, different, or none do not apply(Loop line one-way operation, etc.)

example

GET /v1/xml/station?key=your_access_key_here&code=22828
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Point>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <GeoPoint gcs="tokyo" lati_d="35.678082" longi_d="139.770443" lati="35.40.41.9" longi="139.46.13.59"/>
    <Station code="22828">
      <Name>東京</Name>
      <Yomi>とうきょう</Yomi>
      <Type>train</Type>
    </Station>
  </Point>
</ResultSet>
GET /v1/json/station?key=your_access_key_here&code=22828
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Point": {
      "Prefecture": {
        "code": "13",
        "Name": "東京都"
      },
      "GeoPoint": {
        "gcs": "tokyo",
        "lati_d": "35.678082",
        "longi_d": "139.770443",
        "lati": "35.40.41.9",
        "longi": "139.46.13.59"
      },
      "Station": {
        "code": "22828",
        "Name": "東京",
        "Yomi": "とうきょう",
        "Type": "train"
      }
    }
  }
}
GET /v1/xml/station?key=your_access_key_here&oldName=上鯖江
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Point>
    <Prefecture code="18">
      <Name>福井県</Name>
    </Prefecture>
    <GeoPoint gcs="tokyo" lati_d="35.933415" longi_d="136.183499" lati="35.56.0.29" longi="136.11.0.59"/>
    <Station code="23799">
      <Name>サンドーム西</Name>
      <Yomi>さんどーむにし</Yomi>
      <OldName>上鯖江</OldName>
      <Type>train</Type>
    </Station>
  </Point>
</ResultSet>
GET /v1/json/station?key=your_access_key_here&oldName=上鯖江
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Point": {
      "Prefecture": {
        "code": "18",
        "Name": "福井県"
      },
      "GeoPoint": {
        "gcs": "tokyo",
        "lati_d": "35.933415",
        "longi_d": "136.183499",
        "lati": "35.56.0.29",
        "longi": "136.11.0.59"
      },
      "Station": {
        "code": "23799",
        "Name": "サンドーム西",
        "Yomi": "さんどーむにし",
        "OldName": "上鯖江",
        "Type": "train"
      }
    }
  }
}
ページ上部へ