Station information

Returns information on the station that satisfies the specified conditions.

GET /v1/{format}/station

parameters

Name Type Description
format string Specify response data format. Required.
Possible Values:
- xml: xml data format
- json: json data format
key string Specify 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 can be omitted.
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. Can be omitted. When omitted there is no specification.
prefectureCode int prefecture code. Can be omitted. 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. Can be omitted. oldName, code, railName, operationLineCode time specification cannot be used.
Default: 1
limit int number of data blocks. Can be omitted. 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 company name. Specified corporation only can be used. multiple specifications is possible. Maximum of 10 entries. Can be abbreviated. When omitted, because normal unlimited acquisition.
gcs string If the request and response include coordinates, the geodetic system for the coordinates can be specified. Also, in addition to the coordinate information request parameter, the gcs parameter can be set separately. May be omitted.
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 / gcs Geodetic System
ResultSet / Point / GeoPoint / lati Latitude.
Format: degree.minute.second. 1/100th of a second
ResultSet / Point / GeoPoint / lati_d Latitude.
Format: degree
ResultSet / Point / GeoPoint / longi Longitude.
Format: degree.minute.second. 1/100th of a second
ResultSet / Point / GeoPoint / longi_d Longitude.
Format: Degree
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 / 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"
      }
    }
  }
}