ApiPlace Data Type

A Place is where a journey starts or ends, or a transit stop along the way.

Properties
name data type description
name string For transit stops, the name of the stop. For points of interest, the name of the POI.
stopId string The ID of the stop. This is often something that users don't care about.
stopCode string The "code" of the stop. Depending on the transit agency, this is often something that users care about.
platformCode string The code or name identifying the quay/platform the vehicle will arrive at or depart from
lon number The longitude of the place.
lat number The latitude of the place.
arrival number The time the rider will arrive at the place.
departure number The time the rider will depart the place.
orig string
zoneId string
stopIndex number For transit trips, the stop index (numbered from zero from the start of the trip
stopSequence number For transit trips, the sequence number of the stop. Per GTFS, these numbers are increasing.
vertexType ApiVertexType Type of vertex. (Normal, Bike sharing station, Bike P+R, Transit stop) Mostly used for better localization of bike sharing and P+R station names
bikeShareId string In case the vertex is of type Bike sharing station.

Example

{
  "name" : "...",
  "stopId" : "...",
  "stopCode" : "...",
  "platformCode" : "...",
  "lon" : 12345.0,
  "lat" : 12345.0,
  "arrival" : 12345,
  "departure" : 12345,
  "orig" : "...",
  "zoneId" : "...",
  "stopIndex" : 12345,
  "stopSequence" : 12345,
  "vertexType" : "TRANSIT",
  "bikeShareId" : "..."
}