map

Get all stops for a map section

Changed on
get/api/v6/map/stops

Request

  • Base URL
    https://api.transitous.org
  • URL
    https://api.transitous.org/api/v6/map/stops
  • Auth
    none declared

Query parameters

minstring required

latitude,longitude pair of the lower right coordinate

maxstring required

latitude,longitude pair of the upper left coordinate

groupedboolean

Optional. Return grouped stops

modesMode[]

Optional. Stop modes

languagestring[]

language tags as used in OpenStreetMap / GTFS (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)

Response

array of stop places in the selected map section

namestring required

name of the transit stop / PoI / address

stopIdstring

The ID of the stop. This is often something that users don't care about.

parentIdstring

If it's not a root stop, this field contains the stopId of the parent stop.

importancenumber

The importance of the stop between 0-1.

latnumber required

latitude

lonnumber required

longitude

levelnumber

level according to OpenStreetMap If no level is given, the field will be unset.

For older versions (v1-v5), this field is mandatory and therefore set to 0. Affected endpoints: plan, trip, stoptimes, one-to-all, map/stops, map/trips

tzstring

timezone name (e.g. "Europe/Berlin")

arrivalstring date-time

arrival time

departurestring date-time

departure time

scheduledArrivalstring date-time

scheduled arrival time

scheduledDeparturestring date-time

scheduled departure time

scheduledTrackstring

scheduled track from the static schedule timetable dataset

trackstring

The current track/platform information, updated with real-time updates if available. Can be missing if neither real-time updates nor the schedule timetable contains track information.

stopCodestring

Short, abbreviated identifier of the stop intended for users (e.g. printed on signage, used in SMS / passenger info systems). Comes from the GTFS stop_code field.

descriptionstring

description of the location that provides more detailed information

vertexType'NORMAL' | 'BIKESHARE' | 'TRANSIT'
  • NORMAL - latitude / longitude coordinate or address
  • BIKESHARE - bike sharing station
  • TRANSIT - transit stop
pickupType'NORMAL' | 'NOT_ALLOWED'
  • NORMAL - entry/exit is possible normally
  • NOT_ALLOWED - entry/exit is not allowed
dropoffType'NORMAL' | 'NOT_ALLOWED'
  • NORMAL - entry/exit is possible normally
  • NOT_ALLOWED - entry/exit is not allowed
cancelledboolean

Whether this stop is cancelled due to the realtime situation.

arrivalTimestampReason'NO_RT_DATA' | 'INCONSISTENT_RT' | 'OBSERVED' | 'PROPAGATED' | 'PREDICTED'

Reason for an arrival/departure timestamp, i.e. what the time is based on.

  • NO_RT_DATA - no real-time data available, the time is the scheduled time
  • INCONSISTENT_RT - no consistent real-time data available for this event, the time was changed by MOTIS, e.g. to prevent the vehicle from arriving before departing at a previous stop, or because the real-time data could not be matched unambiguously
  • OBSERVED - the time is a real-time time that was observed/recorded by the real-time data source
  • PROPAGATED - the time is a real-time time that was computed by propagating the real-time delay of a preceding event
  • PREDICTED - the time is a real-time time that was predicted by the real-time data source
departureTimestampReason'NO_RT_DATA' | 'INCONSISTENT_RT' | 'OBSERVED' | 'PROPAGATED' | 'PREDICTED'

Reason for an arrival/departure timestamp, i.e. what the time is based on.

  • NO_RT_DATA - no real-time data available, the time is the scheduled time
  • INCONSISTENT_RT - no consistent real-time data available for this event, the time was changed by MOTIS, e.g. to prevent the vehicle from arriving before departing at a previous stop, or because the real-time data could not be matched unambiguously
  • OBSERVED - the time is a real-time time that was observed/recorded by the real-time data source
  • PROPAGATED - the time is a real-time time that was computed by propagating the real-time delay of a preceding event
  • PREDICTED - the time is a real-time time that was predicted by the real-time data source
flexstring

for FLEX transports, the flex location area or location group name

flexIdstring

for FLEX transports, the flex location area ID or location group ID

flexStartPickupDropOffWindowstring date-time

Time that on-demand service becomes available

flexEndPickupDropOffWindowstring date-time

Time that on-demand service ends

modesMode[]

available transport modes for stops

Changes

  • c370238a1905Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • dbfe4b7f2babRevision changes
    • warning

      added the new HGV enum value to the // response property for the response status

    • info

      added the enum value HGV to the property items/ of the query request parameter modes