Data Dictionary

Field Name Name Type Description Fixed Values
header Feed Header FeedHeader() Metadata about a feed, included in feed messages.
header.gtfs_realtime_version GTFS Realtime Version STRING() Version of the feed specification. The current version is 2.0.
header.incrementality Incrementality ENUM()

Determines whether the current fetch is incremental. Options include:

-FULL_DATASET: this feed update will overwrite all preceding realtime information for the feed. Thus this update is expected to provide a full snapshot of all known realtime information.

-DIFFERENTIAL: currently, this 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.

FULL_DATASET, DIFFERENTIAL
header.timestamp Feed Header Timestamp int64() This timestamp identifies the moment when the content of this feed has been created (in server time). In POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC). To avoid time skew between systems producing and consuming realtime information it is strongly advised to derive timestamp from a time server. It is completely acceptable to use Stratum 3 or even lower strata servers since time differences up to a couple of seconds are tolerable.
entity Feed Entity FeedEntity() A definition (or update) of an entity in the transit feed. If the entity is not being deleted, exactly one of trip_update, vehicle, and alert fields should be populated. This field can be repeated as many times as needed.
entity.id Feed Entity ID STRING() Feed-unique identifier for this entity. The ids are used only to provide incrementality support. The actual entities referenced by the feed must be specified by explicit selectors (see EntitySelector below for more info).
entity.alert Feed Entity Alert Alert() An alert, indicating some sort of incident in the public transit network.
alert.informed_entity Alert Informed Entity EntitySelector() Entities whose users we should notify of this alert. At least one informed_entity must be provided. This field can be repeated as many times as needed.
alert.informed_entity.route_id Alert Informed Entity Route ID STRING() The route_id from the GTFS that this selector refers to. If direction_id is provided, route_id must also be provided.
alert.url Alert URL TranslatedString() The URL which provides additional information about the alert.
alert.url.translation Alert URL Translation Translation() A localized string mapped to a language. This field can be repeated as many times as needed.
alert.url.translation.text Alert URL Translation Text STRING() A UTF-8 string containing the message.
alert.url.translation.language Alert URL Translation Language STRING() BCP-47 language code. Can be omitted if the language is unknown or if no internationalization is done at all for the feed. At most one translation is allowed to have an unspecified language tag - if there is more than one translation, the language must be provided.
alert.header_text Alert Header Text TranslatedString() Header for the alert. This plain-text string will be highlighted, for example in boldface.
alert.header_text.translation Alert Header Text Translation Translation() A localized string mapped to a language. This field can be repeated as many times as needed.
alert.header_text.translation.language Alert Header Text Translation Language STRING() BCP-47 language code. Can be omitted if the language is unknown or if no internationalization is done at all for the feed. At most one translation is allowed to have an unspecified language tag - if there is more than one translation, the language must be provided.
alert.description_text Alert Description Text TranslatedString() Description for the alert. This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user). The information in the description should add to the information of the header.
alert.header_text.translation Alert Description Text Translation Translation() A localized string mapped to a language. This field can be repeated as many times as needed.
alert.header_text.translation.text Alert Description Text Translation Text STRING() A UTF-8 string containing the message.
alert.header_text.translation.language Alert Description Text Translation Language STRING() BCP-47 language code. Can be omitted if the language is unknown or if no internationalization is done at all for the feed. At most one translation is allowed to have an unspecified language tag - if there is more than one translation, the language must be provided.

Additional information

Field Value
Format API
License Creative Commons Attribution 4.0
Open Data Title GTFS Realtime - Service Alerts - Yarra Trams
Dataset Security Value BIL1 OFFICIAL - Authorised Public Release
Geographic Coordinate System WGS84
Geographic Coverage Metropolitan Melbourne