GTFS Realtime Reference

A GTFS realtime feed lets transit agencies provide consumers with real-time information about location of their vehicles, expected arrival times, disruptions to their service (stations closed, lines not operating, important delays), and so on.

Term Definitions

  • Required: Exactly one
  • Repeated: Zero or more
  • Message: Complex type
  • Enum: List of fixed values
  • Experimental: Experimental field, subject to change. It may be formally adopted in the future.

Entities Overview

The following table lists the entities available in the GTFS realtime feed.

Entity Description
message Alert A notification of an incident in the public transit network.
enum Cause The Cause of this Alert.
enum CongestionLevel Congestion level that is affecting this vehicle.
enum Effect The effect of this Alert on the involved entity or entities.
message EntitySelector A selector for an entity (Agency, Stop, Route, and so on) in a GTFS feed.
message FeedEntity A definition (or update) of an entity in the transit feed.
message FeedHeader Metadata about the feed, included in a FeedMessage.
message FeedMessage The contents of a feed message.
enum Incrementality Determines whether the current fetch is incremental.
enum OccupancyStatus (VehiclePosition) The degree of passenger occupancy for the vehicle.
message Position The geographic position of a vehicle.
enum ScheduleRelationship (StopTimeUpdate) The relation between this StopTime and the static schedule.
enum ScheduleRelationship (TripDescriptor) The relation between this trip and the static schedule.
message StopTimeEvent Timing information for a single predicted event (either arrival or departure).
message StopTimeUpdate Realtime update for arrival or departure events for a given stop on a trip.
message TimeRange A time interval.
message TranslatedString An internationalized message containing per-language versions of a text snippet or a URL.
message Translation A localized string mapped to a language.
message TripDescriptor A descriptor that identifies an instance of a GTFS trip, or all instances of a trip along a route.
message TripUpdate Realtime update on the progress of a vehicle along a trip.
message VehicleDescriptor Identification information for the vehicle performing the trip.
message VehiclePosition Real-time positioning information for a given vehicle.
enum VehicleStopStatus The status of the vehicle with respect to a stop.