GTFS Realtime - Vehicle Positions - Yarra Trams
GTFS Realtime Yarra Trams Vehicle Position data feed provides live location information for tram services in Melbourne, Victoria. Note: This API endpoint has a rate limit of 20-27 calls per minute (depending on the data size) and caching time of 30 seconds. To obtain an 'API Key' please continue to signup using our Data Exchange Platform (https://data-exchange.vicroads.vic.gov.au/).
There are no views created for this resource yet.
Data Dictionary
Field Name | Name | Type | Description | Fixed Values |
---|---|---|---|---|
header | Feed Header | FeedHeader() | Metadata about a feed, included in feed messages. | |
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. | |
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.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.is_deleted | Feed Entity Is Deleted | BOOLEAN() | Whether this entity is to be deleted. Should be provided only for feeds with Incrementality of DIFFERENTIAL - this field should NOT be provided for feeds with Incrementality of FULL_DATASET. | |
entity.vehicle | Feed Entity Vehicle Position | VehiclePosition() | Data about the realtime position of a vehicle. At least one of the fields trip_update, vehicle, or alert must be provided - all these fields cannot be empty. | |
vehicle.trip | Vehicle Trip | TripDescriptor() | The Trip that this vehicle is serving. Can be empty or partial if the vehicle can not be identified with a given trip instance. | |
vehicle.vehicle | Vehicle Position Vehicle | VehicleDescriptor() | Additional information on the vehicle that is serving this trip. Each entry should have a unique vehicle ID. | |
vehicle.position | Position | Position() | Current position of this vehicle. | |
vehicle.current_status | Current Status | ENUM() | The exact status of the vehicle with respect to the current stop. Ignored if current_stop_sequence is missing. Options include: -INCOMING_AT: The vehicle is just about to arrive at the stop (on a stop display, the vehicle symbol typically flashes). -STOPPED_AT: The vehicle is standing at the stop. -IN_TRANSIT_TO: The vehicle has departed the previous stop and is in transit. |
INCOMING_AT, STOPPED_AT, IN_TRANSIT_TO |
vehicle.timestamp | Timestamp | int64() | Moment at which the vehicle's position was measured. In POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC). | |
vehicle.position.latitude | Position Latitude | FLOAT() | Degrees North, in the WGS-84 coordinate system. | |
vehicle.position.longitude | Position Longitude | FLOAT() | Degrees East, in the WGS-84 coordinate system. | |
vehicle.trip.trip_id | Vehicle Trip ID | STRING() | The trip_id from the GTFS feed that this selector refers to. Whether trip_id is required depends on the type of trip: - Non-frequency-based trips: The trip_id field alone is enough to uniquely identify these trips. Note that non-frequency-based trips aren't defined in GTFS frequencies.txt. - Frequency-based trips: The trip_id, start_time, and start_date fields are all required. Frequency-based trips are defined in GTFS frequencies.txt. - Schedule-based trips: The trip_id field can be omitted only if the trip can be uniquely identified by a combination of the provided route_id, direction_id, start_time, and start_date fields. Note that scheduled-based trips aren't defined in GTFS frequencies.txt. |
|
vehicle.trip.start_time | Vehicle Trip Start Time | STRING() | The initially scheduled start time of this trip instance. The field type Time defines the format of this field, for example 11:15:35 or 25:15:35. Whether the start_time field is required depends on the type of trip: • The trip_id corresponds to a non-frequency-based trip: The start_time field needs to either be omitted or be equal to the value of departure_time in the GTFS feed's stop_times.txt file. • The trip_id corresponds to a frequency-based trip: start_time is always required and must be specified for trip updates and vehicle positions. Frequency-based trips are defined in GTFS frequencies.txt. ◦ If the frequency-based trip corresponds to an exact_times=1 GTFS record: The start_time field must be some multiple, including zero, of headway_secs later than the frequencies.txt start_time for the corresponding time period. ◦ If the frequency-based trip corresponds to an exact_times=0 GTFS record: The start_time can be arbitrary, and it's initially expected to be the first departure of the trip. After it's established, the start_time of this frequency-based exact_times=0 trip is considered immutable, even if the first departure time changes. Any subsequent time changes can instead be reflected in a StopTimeUpdate message. • The trip_id is omitted: start_time must be provided. |
|
vehicle.trip.start_date | Vehicle Trip Start Date | STRING() | The start date of this trip instance in YYYYMMDD format. Whether start_date is required depends on the type of trip: - Scheduled trips: start_date must be provided. This is to disambiguate trips that are so late that they collide with a scheduled trip on the next day. For example, suppose a train departs at 8:00 and 20:00 every day. If the train is 12 hours late, then there would be two distinct trips scheduled for the same time. Note: This field is optional for scheduled trips in which such collisions are impossible. For example, this could happen if a service runs on an hourly schedule, and a vehicle that's one hour late isn't considered related to the schedule anymore. - Frequency-based trips: start_date must be provided. Note that frequency-based trips are defined in the GTFS frequencies.txt file, while scheduled trips aren't. - trip_id is omitted: start_date must be provided. |
|
vehicle.vehicle.id | Vehicle Position Vehicle ID | STRING() | Internal system identification of the vehicle. Should be unique per vehicle, and is used for tracking the vehicle as it proceeds through the system. This id should not be made visible to the end-user; for that purpose use the label field. | |
vehicle.vehicle.label | Vehicle Position Vehicle Label | STRING() | User visible label, i.e., something that must be shown to the passenger to help identify the correct vehicle. |
Additional Information
Field | Value |
---|---|
Data last updated | 16 November 2024 |
Metadata last updated | 11 December 2024 |
Created | 16 November 2024 |
Format | API |
License | Creative Commons Attribution 4.0 International |
Api url | https://data-exchange-api.vicroads.vic.gov.au/opendata/gtfsr/v1/tram/vehicleposition |
Attributes | [{"attribute_display_order_id": 1, "db_format": "FeedHeader()", "db_name": "header", "definition": "Metadata about a feed, included in feed messages.", "fixed_values": "", "id": "1346", "name": "Feed Header", "ref_number": "AT-1346"}, {"attribute_display_order_id": 2, "db_format": "FeedEntity()", "db_name": "entity", "definition": "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.", "fixed_values": "", "id": "1347", "name": "Feed Entity", "ref_number": "AT-1347"}, {"attribute_display_order_id": 3, "db_format": "STRING()", "db_name": "header.gtfs_realtime_version", "definition": "Version of the feed specification. The current version is 2.0.", "fixed_values": "", "id": "1348", "name": "GTFS Realtime Version", "ref_number": "AT-1348"}, {"attribute_display_order_id": 4, "db_format": "ENUM()", "db_name": "header.incrementality", "definition": "<p>Determines whether the current fetch is incremental. Options include:</p>\n<p>-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.</p>\n<p>-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.</p>", "fixed_values": "FULL_DATASET, DIFFERENTIAL", "id": "1349", "name": "Incrementality", "ref_number": "AT-1349"}, {"attribute_display_order_id": 5, "db_format": "int64()", "db_name": "header.timestamp", "definition": "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.", "fixed_values": "", "id": "1350", "name": "Feed Header Timestamp", "ref_number": "AT-1350"}, {"attribute_display_order_id": 6, "db_format": "STRING()", "db_name": "entity.id", "definition": "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).", "fixed_values": "", "id": "1351", "name": "Feed Entity ID", "ref_number": "AT-1351"}, {"attribute_display_order_id": 7, "db_format": "BOOLEAN()", "db_name": "entity.is_deleted", "definition": "Whether this entity is to be deleted. Should be provided only for feeds with Incrementality of DIFFERENTIAL - this field should NOT be provided for feeds with Incrementality of FULL_DATASET.", "fixed_values": "", "id": "1352", "name": "Feed Entity Is Deleted", "ref_number": "AT-1352"}, {"attribute_display_order_id": 8, "db_format": "VehiclePosition()", "db_name": "entity.vehicle", "definition": "Data about the realtime position of a vehicle. At least one of the fields trip_update, vehicle, or alert must be provided - all these fields cannot be empty.", "fixed_values": "", "id": "1353", "name": "Feed Entity Vehicle Position", "ref_number": "AT-1353"}, {"attribute_display_order_id": 9, "db_format": "TripDescriptor()", "db_name": "vehicle.trip", "definition": "The Trip that this vehicle is serving. Can be empty or partial if the vehicle can not be identified with a given trip instance.", "fixed_values": "", "id": "1354", "name": "Vehicle Trip", "ref_number": "AT-1354"}, {"attribute_display_order_id": 10, "db_format": "VehicleDescriptor()", "db_name": "vehicle.vehicle", "definition": "Additional information on the vehicle that is serving this trip. Each entry should have a unique vehicle ID.", "fixed_values": "", "id": "1361", "name": "Vehicle Position Vehicle", "ref_number": "AT-1361"}, {"attribute_display_order_id": 11, "db_format": "Position()", "db_name": "vehicle.position", "definition": "Current position of this vehicle.", "fixed_values": "", "id": "1365", "name": "Position", "ref_number": "AT-1365"}, {"attribute_display_order_id": 12, "db_format": "ENUM()", "db_name": "vehicle.current_status", "definition": "<p>The exact status of the vehicle with respect to the current stop. Ignored if current_stop_sequence is missing. Options include:</p>\n<p>-INCOMING_AT: The vehicle is just about to arrive at the stop (on a stop display, the vehicle symbol typically flashes).</p>\n<p>-STOPPED_AT: The vehicle is standing at the stop.</p>\n<p>-IN_TRANSIT_TO: The vehicle has departed the previous stop and is in transit.</p>", "fixed_values": "INCOMING_AT, STOPPED_AT, IN_TRANSIT_TO", "id": "1373", "name": "Current Status", "ref_number": "AT-1373"}, {"attribute_display_order_id": 13, "db_format": "int64()", "db_name": "vehicle.timestamp", "definition": "Moment at which the vehicle's position was measured. In POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC).", "fixed_values": "", "id": "1374", "name": "Timestamp", "ref_number": "AT-1374"}, {"attribute_display_order_id": 14, "db_format": "FLOAT()", "db_name": "vehicle.position.latitude", "definition": "Degrees North, in the WGS-84 coordinate system.", "fixed_values": "", "id": "1366", "name": "Position Latitude", "ref_number": "AT-1366"}, {"attribute_display_order_id": 15, "db_format": "FLOAT()", "db_name": "vehicle.position.longitude", "definition": "Degrees East, in the WGS-84 coordinate system.", "fixed_values": "", "id": "1367", "name": "Position Longitude", "ref_number": "AT-1367"}, {"attribute_display_order_id": 16, "db_format": "STRING()", "db_name": "vehicle.trip.trip_id", "definition": "<p>The trip_id from the GTFS feed that this selector refers to. Whether trip_id is required depends on the type of trip:</p>\n<p>- Non-frequency-based trips: The trip_id field alone is enough to uniquely identify these trips. Note that non-frequency-based trips aren't defined in GTFS frequencies.txt.</p>\n<p>- Frequency-based trips: The trip_id, start_time, and start_date fields are all required. Frequency-based trips are defined in GTFS frequencies.txt.</p>\n<p>- Schedule-based trips: The trip_id field can be omitted only if the trip can be uniquely identified by a combination of the provided route_id, direction_id, start_time, and start_date fields. Note that scheduled-based trips aren't defined in GTFS frequencies.txt.</p>", "fixed_values": "", "id": "1355", "name": "Vehicle Trip ID", "ref_number": "AT-1355"}, {"attribute_display_order_id": 17, "db_format": "STRING()", "db_name": "vehicle.trip.start_time", "definition": "<p>The initially scheduled start time of this trip instance. The field type Time defines the format of this field, for example 11:15:35 or 25:15:35. Whether the start_time field is required depends on the type of trip:</p>\n<p>\u2022 The trip_id corresponds to a non-frequency-based trip: The start_time field needs to either be omitted or be equal to the value of departure_time in the GTFS feed's stop_times.txt file.</p>\n<p>\u2022 The trip_id corresponds to a frequency-based trip: start_time is always required and must be specified for trip updates and vehicle positions. Frequency-based trips are defined in GTFS frequencies.txt.</p>\n<p>\u25e6 If the frequency-based trip corresponds to an exact_times=1 GTFS record: The start_time field must be some multiple, including zero, of headway_secs later than the frequencies.txt start_time for the corresponding time period.</p>\n<p>\u25e6 If the frequency-based trip corresponds to an exact_times=0 GTFS record: The start_time can be arbitrary, and it's initially expected to be the first departure of the trip. After it's established, the start_time of this frequency-based exact_times=0 trip is considered immutable, even if the first departure time changes. Any subsequent time changes can instead be reflected in a StopTimeUpdate message.</p>\n<p>\u2022 The trip_id is omitted: start_time must be provided.</p>", "fixed_values": "", "id": "1358", "name": "Vehicle Trip Start Time", "ref_number": "AT-1358"}, {"attribute_display_order_id": 18, "db_format": "STRING()", "db_name": "vehicle.trip.start_date", "definition": "<p>The start date of this trip instance in YYYYMMDD format. Whether start_date is required depends on the type of trip:</p>\n<p>- Scheduled trips: start_date must be provided. This is to disambiguate trips that are so late that they collide with a scheduled trip on the next day. For example, suppose a train departs at 8:00 and 20:00 every day. If the train is 12 hours late, then there would be two distinct trips scheduled for the same time.</p>\n<p>Note: This field is optional for scheduled trips in which such collisions are impossible. For example, this could happen if a service runs on an hourly schedule, and a vehicle that's one hour late isn't considered related to the schedule anymore.</p>\n<p>- Frequency-based trips: start_date must be provided. Note that frequency-based trips are defined in the GTFS frequencies.txt file, while scheduled trips aren't.</p>\n<p>- trip_id is omitted: start_date must be provided.</p>", "fixed_values": "", "id": "1359", "name": "Vehicle Trip Start Date", "ref_number": "AT-1359"}, {"attribute_display_order_id": 19, "db_format": "STRING()", "db_name": "vehicle.vehicle.id", "definition": "Internal system identification of the vehicle. Should be unique per vehicle, and is used for tracking the vehicle as it proceeds through the system. This id should not be made visible to the end-user; for that purpose use the label field.", "fixed_values": "", "id": "1362", "name": "Vehicle Position Vehicle ID", "ref_number": "AT-1362"}, {"attribute_display_order_id": 20, "db_format": "STRING()", "db_name": "vehicle.vehicle.label", "definition": "User visible label, i.e., something that must be shown to the passenger to help identify the correct vehicle.", "fixed_values": "", "id": "1363", "name": "Vehicle Position Vehicle Label", "ref_number": "AT-1363"}] |
Datastore active | False |
Datastore contains all records of source file | False |
Has views | False |
Historical | False |
Id | 81ada2e3-c4d3-4324-9192-8fbaf62ca336 |
Last updated date | 1 month ago |
Mimetype | application/json |
Open dataset title | GTFS Realtime - Vehicle Positions - Yarra Trams |
Package id | f01ce1b0-e0d1-4182-9d0f-20cdc0a32be9 |
Position | 2 |
Publication date | 1 year ago |
State | active |
File Size | 2.3 KB |
Release Date | |
Temporal Coverage Start | |
Temporal Coverage End | |
Data Quality Statement | |
Attribution Statement |