Expand description
GTFS Readers
Structs§
- GTFS
Agency - Agency Information
- GTFS
Area - Areas
- GTFS
Attribution - Attributions
- GTFS
Booking Rule - Booking Rules
- GTFS
Calendar - Calendar Information
- GTFS
Calendar Date - Calendar Dates
- GTFS
Fare Attribute - Fare Attributes (GTFS-Fares V1)
- GTFS
Fare LegJoin Rule - Fare Leg Join Rules
- GTFS
Fare LegRule - Fare Leg Rules
- GTFS
Fare Media - Fare Media
- GTFS
Fare Product - Fare Products
- GTFS
Fare Rule - Fare Rules
- GTFS
Fare Transfer Rule - Fare Transfer Rules
- GTFS
Feed Info - Feed Information
- GTFS
Frequency - Frequency
- GTFS
Level - Levels
- GTFS
Location Group - Location Groups
- GTFS
Location Group Stop - Location Group Stops
- GTFS
Locations Properties locations.geojsondata properties Defines zones where riders can request either pickup or drop off by on-demand services. These zones are represented as GeoJSON polygons.- GTFS
Network - Networks
- GTFS
Pathway - Pathways
- GTFS
Realtime Alert - An alert, indicating some sort of incident in the public transit network.
- GTFS
Realtime Entity - A definition (or update) of an entity in the transit feed. May be a TripUpdate, VehiclePosition, Alert, Shape, Stop, and/or TripModifications. At least one of the above must be present (unless the entity is being deleted).
- GTFS
Realtime Entity Selector - A selector for an entity in a GTFS feed. The values of the fields should correspond to the appropriate fields in the GTFS feed. At least one specifier must be given. If several are given, then the matching has to apply to all the given specifiers.
- GTFS
Realtime Header - Metadata about a feed, included in feed messages.
- GTFS
Realtime Modification - A
Modificationmessage replaces a span of n stop times from each affected trip starting atstart_stop_selector. - GTFS
Realtime Modified Trip Selector - A descriptor that identifies an instance of a GTFS trip, or all instances of a trip along a route.
- GTFS
Realtime Multi Carriage Details - Carriage specific details, used for vehicles composed of several carriages This message/field is still experimental, and subject to change. It may be formally adopted in the future.
- GTFS
Realtime Position - A Position is a point on the Earth’s surface.
- GTFS
Realtime Reader - GTFS Realtime message.
- GTFS
Realtime Replacement Stop - NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
- GTFS
Realtime Selected Trips - Selected trips affected by TripModifications.
- GTFS
Realtime Shape - Describes the physical path that a vehicle takes when it’s not part of the (CSV) GTFS, such as for a detour. Shapes belong to Trips, and consist of a sequence of shape points. Tracing the points in order provides the path of the vehicle. Shapes do not need to intercept the location of Stops exactly, but all Stops on a trip should lie within a small distance of the shape for that trip, i.e. close to straight line segments connecting the shape points NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future
- GTFS
Realtime Stop - Describes a stop which is served by trips. All fields are as described in the GTFS-Static specification. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
- GTFS
Realtime Stop Selector - NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future. Select a stop by stop sequence or by stop_id. At least one of the two values must be provided.
- GTFS
Realtime Stop Time Event - Timing information for a single predicted event (either arrival or departure).
- GTFS
Realtime Stop Time Properties - Provides the updated values for the stop time. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
- GTFS
Realtime Stop Time Update - Realtime update for arrival and/or departure events for a given stop on a trip. Updates can be supplied for both past and future events. The producer is allowed, although not required, to drop past events.
- GTFS
Realtime Time Range - A time interval. The interval is considered active at time ‘t’ if ‘t’ is greater than or equal to the start time and less than the end time.
- GTFS
Realtime Translated String - An internationalized message containing per-language versions of a snippet of text or a URL. One of the strings from a message will be picked up. The resolution proceeds as follows:
- GTFS
Realtime Translation - The translations field of a GTFSRealtimeTranslatedString
- GTFS
Realtime Trip Descriptor - A descriptor that identifies an instance of a GTFS trip, or all instances of a trip along a route.
- GTFS
Realtime Trip Modifications - NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
- GTFS
Realtime Trip Properties - Defines updated properties of the trip, such as a new shape_id when there is a detour. Or defines the trip_id, start_date, and start_time of a DUPLICATED trip. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future
- GTFS
Realtime Trip Update - Realtime update of the progress of a vehicle along a trip. Depending on the value of ScheduleRelationship, a TripUpdate can specify:
- GTFS
Realtime Vehicle Descriptor - Identification information for the vehicle performing the trip.
- GTFS
Realtime Vehicle Position - Realtime positioning information for a given vehicle.
- GTFS
Route - Route Information
- GTFS
Route Network - Route Networks
- GTFS
Schedule Iterator - The GTFS Schedule Iterator tool
- GTFS
Schedule Reader - GTFS Schedule Reader
- GTFS
Shape - Shapes
- GTFS
ShapeM Value - Shape MValue
- GTFS
Shape Properties - Shape Properties
- GTFS
Shapes - Shapes
- GTFS
Stop - Stop Information
- GTFS
Stop Area - Stop Areas
- GTFS
Stop Properties - Properties object from GTFS stops
- GTFS
Stop Time - Stop Time Information
- GTFS
Timeframe - Timeframes
- GTFS
Transfer - Transfers
- GTFS
Translation - Translations
- GTFS
Trip - Trip Information
- Piece
- A piece of the GTFS schedule
Enums§
- GTFS
Bikes Allowed - Indicates whether bikes are allowed. Valid options are:
- GTFS
Booking Type - Describes how far in advance rider can book: 0 - Real-time 1 - Same-day (with advance notice) 2 - Prior day(s)
- GTFS
Continuous Pickup Drop Off - Continuous pickup behavior from this stop_time to the next.
- GTFS
DayAvailability - Enumeration to represent day availability in the calendar. 0 = Not available, 1 = Available
- GTFS
Direction Id - Indicates the direction of travel for a trip. This field should not be used in routing; it provides a way to separate trips by direction when publishing time tables. Valid options are:
- GTFS
Duration Limit Type - Duration limit type for how transfer durations are measured.
Required if
duration_limitis defined, forbidden otherwise. - GTFS
Exact Times - Indicates the type of service for a trip with frequencies: 0 or empty = Frequency-based trips 1 = Schedule-based trips (with identical headway)
- GTFS
Exception Type - Describes whether service is added or removed on a specific date. 1 - Service added for this date. 2 - Service removed for this date.
- GTFS
Fare Media Type - Describes the type of fare media used. 0 - None 1 - Physical paper ticket 2 - Physical transit card 3 - cEMV (contactless) 4 - Mobile app
- GTFS
Fare Transfer Type - Fare transfer type describing how costs are processed between consecutive legs:
- GTFS
Incrementality - Determines whether the current fetch is incremental. Currently, DIFFERENTIAL mode is unsupported and behavior is unspecified for feeds that use this mode. There are discussions on the GTFS Realtime mailing list around fully specifying the behavior of DIFFERENTIAL mode and the documentation will be updated when those discussions are finalized.
- GTFS
IsBidirectional - Indicates whether a pathway can be used in both directions:
- GTFS
Pathway Mode - Describes the type of pathway between two stops or station nodes.
- GTFS
Payment Method - Indicates when the fare must be paid:
- GTFS
Pickup Drop OffType - Pickup method.
- GTFS
Realtime Cause - Cause of this alert. If cause_detail is included, then Cause must also be included.
- GTFS
Realtime Congestion Level - Congestion level that is affecting this vehicle.
- GTFS
Realtime Effect - What is the effect of this problem on the affected entity. If effect_detail is included, then Effect must also be included.
- GTFS
Realtime Entity Message - The type of a GTFSRealtimeEntity message
- GTFS
Realtime Occupancy Status - The state of passenger occupancy for the vehicle or carriage.
Individual producers may not publish all OccupancyStatus values. Therefore, consumers
must not assume that the OccupancyStatus values follow a linear scale.
Consumers should represent OccupancyStatus values as the state indicated
and intended by the producer. Likewise, producers must use OccupancyStatus values that
correspond to actual vehicle occupancy states.
For describing passenger occupancy levels on a linear scale, see
occupancy_percentage. This field is still experimental, and subject to change. It may be formally adopted in the future. - GTFS
Realtime Schedule Relationship - The relation between this trip and the static schedule. If a trip is done in accordance with temporary schedule, not reflected in GTFS, then it shouldn’t be marked as SCHEDULED, but likely as ADDED.
- GTFS
Realtime Schedule Relationship Update - The relation between the StopTimeEvents and the static schedule.
- GTFS
Realtime Severity Level - Severity of this alert.
- GTFS
Realtime Wheelchair Accessible - Wheelchair accessibility of the trip
- GTFS
Realtime Wheelchair Boarding - The type of wheelchair boarding accessibility at a stop.
- GTFS
Route Pickup Type - Continuous pickup setting for the entire route. 0 - Continuous stopping pickup, 1/empty - No continuous stopping pickup, 2 - Must phone agency, 3 - Must coordinate with driver.
- GTFS
Route Type - Indicates the type of transportation used on a route. Valid options include: 0 - Tram 1 - Subway 2 - Rail 3 - Bus 4 - Ferry, 5 - Cable tram 6 - Aerial lift 7 - Funicular, 11 - Trolleybus 12 - Monorail.
- GTFS
Stop Location Type - Location type. Valid options:
- GTFS
Timepoint - Indicates if arrival/departure times are exact or approximate.
- GTFS
Transfer Type - TransferType enumerates how a rider can transfer between routes/trips/stops:
- GTFS
Transfers Type - Transfers can be:
- GTFS
Vehicle Stop Status - Status of the vehicle relative to the stop
- GTFS
Wheelchair Accessibility - Indicates wheelchair accessibility. Valid options are:
Functions§
- parse_
gtfs_ date - Convenience method to parse a GTFS date (YYYYMMDD) into a JavaScript Date. Because GTFS dates do not contain timezone info, this function treats them as local dates.