Public Transit Stops
This API provides access to public transport data including agencies, routes, stops, trips, service alerts, and live vehicle crowding. Fetch and explore real-time public transportation information from selected positions on the map.
The public transport data structure follows the General Transit Feed Specification (GTFS) and offers access to a subset of GTFS fields and entities.
Key features:
- Query public transport overlays by screen position
- Retrieve information about transport agencies, stops, routes, and trips
- Access real-time data including delays and cancellations
- View GTFS-RT service alerts (disruptions, detours, closures) scoped to stops and trips
- Access live vehicle crowding and occupancy data for trips and routes
- View metadata about accessibility, bike allowances, and platform details
- Filter trips by route type, route short name, or agency
How it works:
- Set a position on the map using
setCursorScreenPosition - Query for public transport overlays with
cursorSelectionOverlayItemsByType - Retrieve stop information using
getPTStopInfo()on each overlay item - Use the returned
PTStopInfoobject to explore agencies, stops, and trips
Query Public Transit Stops
In order to query public transit stops, register a long-press listener on the map controller. When the user long-presses on the map, set the cursor position to that location and retrieve the public transit overlay items at that position.
controller.registerOnLongPress((pos) async {
// set cursor position on the screen
await controller.setCursorScreenPosition(pos);
// get the public transit overlay items at that position
final items = controller
.cursorSelectionOverlayItemsByType(CommonOverlayId.publicTransport);
// for each overlay item at that position
for (final OverlayItem item in items) {
// get the stop information
final ptStopInfo = await item.getPTStopInfo();
if (ptStopInfo != null) {
// information about agencies
final agencies = ptStopInfo.agencies;
// information about stops and generic routes
// (routes that don't have `heading` set)
final stops = ptStopInfo.stops;
// information about trips (together with
// route, agency, stop times, real-time info, etc.)
final trips = ptStopInfo.trips;
// How to use stops
for (final stop in stops) {
print('Stop id: ${stop.stopId}');
print('Stop name: ${stop.stopName}');
print('Routes:');
for (final route in stop.routes) {
print(' Route id: ${route.routeId}');
print(' Route short name: ${route.routeShortName}');
print(' Route long name: ${route.routeLongName}');
}
}
}
}});
You can also obtain PTStopInfo instances by performing an overlay search using CommonOverlayId.publicTransport. Retrieve the corresponding OverlayItems and use their getPTStopInfo method to access stop information.
See the Search on overlays guide for details.
All returned times are local times represented as DateTime values in UTC (timezone offset 0). Use the TimezoneService to convert them to other time zones.
Two types of public transit stops exist on the map:
OverlayItemstops selected viacursorSelectionOverlayItemsByType- provide extensivePTStopInfodetails and display with a blue icon (default style)Landmarkstops selected viacursorSelectionLandmarks- provide limited details and display with a gray icon (default style)
Filter Trips
Filter trips by route short name, route type, or agency using these PTStopInfo methods:
List<PTTrip> tripsByRouteShortName(String name)
List<PTTrip> tripsByRouteType(PTRouteType type)
List<PTTrip> tripsByAgency(PTAgency agency)
Example:
final trips = ptStopInfo.tripsByRouteType(PTRouteType.bus);
Agencies
The PTAgency class represents a public transport agency.
| Property | Type | Description |
|---|---|---|
id | int | Agency ID |
name | String | Full name of the transit agency. |
url | String? | Optional URL of the transit agency. |
Public Transport Routes
The PTRouteInfo class represents a public transport route.
| Property | Type | Description |
|---|---|---|
routeId | int | Route ID |
routeShortName | String? | Short name of a route. Often a short, abstract identifier (e.g., "32", "100X") that riders use to identify a route. May be null. |
routeLongName | String? | Full name of a route. This name is generally more descriptive than the short name and often includes the route's destination or stop. |
routeType | PTRouteType | Type of route. |
routeColor | Color? | Route color designation that matches public-facing material. May be used to color the route on the map or to be shown on UI elements. |
routeTextColor | Color? | Legible color to use for text drawn against a background of routeColor. |
heading | String? | Optional heading information. |
liveCrowding | PTCrowdingInfo? | Live crowding summary over the route's fresh vehicle positions. Null when the route has no fresh vehicle positions. See Live Crowding. |
PTRouteInfo provides information about public transit routes available at a specific stop. PTRoute represents a computed public transit route between multiple waypoints with detailed instructions.
See Compute Public Transit Routes for computing routes using PTRoute.
Route Types
The PTRouteType enum represents the type of public transport route:
| Enum Case | Description |
|---|---|
bus | Bus, Trolleybus. Used for short and long-distance bus routes. |
underground | Subway, Metro. Any underground rail system within a metropolitan area. |
railway | Rail. Used for intercity or long-distance travel. |
tram | Tram, Streetcar, Light rail. Any light rail or street level system within a metropolitan area. |
waterTransport | Water transport. Used for ferries and other water-based transit. |
misc | Miscellaneous. Includes other types of public transport not covered by the other categories. |
Stops
The PTStop class represents a public transport stop.
| Property | Type | Description |
|---|---|---|
stopId | int | Identifies a location: stop/platform, station, entrance/exit, node or boarding area |
stopName | String | Name of the location. Matches the agency's rider-facing name for the location as printed on a timetable, published online, or represented on signage. |
isStation | bool? | Whether this location is a station or not. A station is considered a physical structure or area that contains one or more platforms. |
routes | List<PTRouteInfo> | Associated routes for the stop. Contains all routes serving this stop, whether active at the given time or not. |
alerts | List<PTAlertInfo> | GTFS-RT service alerts scoped to this stop (e.g., station closure, elevator outage). Empty when none apply. See Service Alerts. |
Stop Times
The PTStopTime class provides details about stop time in a PTTrip.
| Property | Type | Description |
|---|---|---|
stopName | String | The name of the serviced stop. |
coordinates | Coordinates | WGS latitude and longitude for the stop. |
hasRealtime | bool | Whether data is provided in real-time or not. |
delay | int | Delay in seconds. Not available if hasRealtime is false. |
departureTime | DateTime? | Optional departure time in the local timezone. |
isBefore | bool | Whether the stop time is before the current time. |
isWheelchairFriendly | bool | Whether the stop is wheelchair accessible. |
Trips
The PTTrip class represents a public transport trip.
| Property | Type | Description |
|---|---|---|
route | PTRouteInfo | Associated route |
agency | PTAgency | Associated agency |
tripIndex | int | Trip index |
tripDate | DateTime? | The date of the trip |
departureTime | DateTime? | Departure time of the trip from the first stop |
hasRealtime | bool | Whether real-time data is available |
isCancelled | bool? | Whether the trip is cancelled |
delayMinutes | int? | Delay in minutes. Not available if hasRealtime is false. |
stopTimes | List<PTStopTime> | Details of stop times in the trip |
stopIndex | int | Stop index |
stopPlatformCode | String? | Platform code for the stop. May be null. |
isWheelchairAccessible | bool | Whether the trip is wheelchair accessible. |
isBikeAllowed | bool | Whether bikes are allowed on the trip. |
alerts | List<PTAlertInfo> | GTFS-RT service alerts applicable to this trip. Empty when none apply. See Service Alerts. |
vehicle | PTCrowdingInfo? | Live crowding of the vehicle running this trip. Present when a fresh vehicle position reports exactly this trip instance, usually only the currently running vehicle. May be null. |
departureOccupancyStatus | PTOccupancyStatus? | Predicted occupancy after departing this stop. May be null. |
When both vehicle and departureOccupancyStatus are present, vehicle.occupancyStatus is the measured (live) value and departureOccupancyStatus is predicted. Prefer the live value for the currently running vehicle and the predicted value for upcoming departures.
A PTAlertEffect.noService alert overlaps with isCancelled. The isCancelled flag remains the authoritative cancellation indicator; the alert supplies the user-facing reason.
PTRouteInfo represents the public-facing service riders recognize (e.g., "Bus 42"). PTTrip is a single scheduled journey along that route at a specific time with its own stop times and sequence. The route is the line identity; trips are individual vehicle runs throughout the day.
Service Alerts
The PTAlertInfo class represents a GTFS-RT service alert, such as a strike, detour, or station closure. Alerts are provided deduplicated in PTStopInfo.alerts and referenced by the trips (PTTrip.alerts) and stops (PTStop.alerts) they apply to. Those lists share the same PTAlertInfo instances.
| Property | Type | Description |
|---|---|---|
cause | PTAlertCause | The cause of the alert. |
effect | PTAlertEffect | The effect of the alert. |
activePeriods | List<PTAlertActivePeriod> | Periods when the alert is active. An empty list means the alert is active for as long as the feed carries it. |
urls | List<PTAlertTranslation> | URL translations pointing to additional information. May be empty. |
headerTexts | List<PTAlertTranslation> | Header text translations summarizing the alert. May be empty. |
descriptionTexts | List<PTAlertTranslation> | Description text translations detailing the alert. May be empty. |
severityLevel | PTAlertSeverityLevel? | The severity of the alert. Null when the feed supplies none. |
causeDetails | List<PTAlertTranslation> | Agency-specific cause wording translations. May be empty. |
effectDetails | List<PTAlertTranslation> | Agency-specific effect wording translations. May be empty. |
To read a localized text field, use the per-field helpers, which return the text for a given language tag (e.g. en) or null when the corresponding list is empty:
String? urlFor(String language)
String? headerTextFor(String language)
String? descriptionTextFor(String language)
String? causeDetailFor(String language)
String? effectDetailFor(String language)
These delegate to PTAlertInfo.selectTranslation, which returns the first translation matching the language tag, or the first entry as a fallback.
for (final alert in ptStopInfo.alerts) {
print('Cause: ${alert.cause}');
print('Effect: ${alert.effect}');
print('Severity: ${alert.severityLevel}');
print('Header: ${alert.headerTextFor('en')}');
print('Description: ${alert.descriptionTextFor('en')}');
}
// Alerts scoped to a specific trip or stop
final tripAlerts = trip.alerts;
final stopAlerts = stop.alerts;
The translations (urls, headerTexts, descriptionTexts, causeDetails, effectDetails) are passed through verbatim from the GTFS-RT feed. The language tags may be inaccurate, since some feeds tag the same untranslated text under multiple languages. Treat them as hints and rely on the fallback behavior of selectTranslation.
PTAlertInfo provides alerts for public transport data associated with stops. Do not confuse it with PTAlert, which represents an alert of a computed public transport route segment.
Alert Cause
The PTAlertCause enum classifies the cause of an alert (GTFS-RT Cause). Values outside the GTFS-RT enum map to unknownCause.
| Enum Case | Description |
|---|---|
unknownCause | Unknown cause. |
otherCause | Other cause not represented by any other value. |
technicalProblem | Technical problem. |
strike | Strike. |
demonstration | Demonstration. |
accident | Accident. |
holiday | Holiday. |
weather | Weather. |
maintenance | Maintenance. |
construction | Construction. |
policeActivity | Police activity. |
medicalEmergency | Medical emergency. |
Alert Effect
The PTAlertEffect enum classifies the effect of an alert (GTFS-RT Effect). Values outside the GTFS-RT enum map to unknownEffect.
| Enum Case | Description |
|---|---|
noService | No service. Overlaps with PTTrip.isCancelled; the trip flag remains the authoritative cancellation indicator. |
reducedService | Reduced service. |
significantDelays | Significant delays. |
detour | Detour. |
additionalService | Additional service. |
modifiedService | Modified service. |
otherEffect | Other effect not represented by any other value. |
unknownEffect | Unknown effect. |
stopMoved | Stop moved. |
noEffect | No effect. |
accessibilityIssue | Accessibility issue. |
Alert Severity
The PTAlertSeverityLevel enum describes the severity of an alert (GTFS-RT SeverityLevel). Values outside the GTFS-RT enum map to unknown.
| Enum Case | Description |
|---|---|
unknown | Unknown severity. |
info | Information. |
warning | Warning. |
severe | Severe. |
Active Period
The PTAlertActivePeriod class represents a period when an alert is active. Both bounds are optional.
| Property | Type | Description |
|---|---|---|
start | DateTime? | UTC start of the period. Null means active since forever. |
end | DateTime? | UTC end of the period. Null means open-ended. |
Translation
The PTAlertTranslation class represents a single translation of an alert text field.
| Property | Type | Description |
|---|---|---|
language | String | Language tag, verbatim from the feed. May be inaccurate. |
text | String | Translation text. |
Live Crowding
The PTCrowdingInfo class exposes live vehicle crowding data derived from GTFS-RT vehicle positions. It appears in two places:
PTTrip.vehicle— the measured values reported by the vehicle running exactly that trip instance.vehiclesis always null here.PTRouteInfo.liveCrowding— a summary over all the route's fresh vehicle positions.vehiclescounts them and the other fields carry the worst value over those vehicles.
| Property | Type | Description |
|---|---|---|
vehicles | int? | Number of fresh vehicle positions on the route. Only provided by PTRouteInfo.liveCrowding; always null for PTTrip.vehicle. |
congestionLevel | PTCongestionLevel? | Congestion level of the traffic the vehicle(s) travel in. May be null. |
occupancyStatus | PTOccupancyStatus? | Occupancy status of the vehicle(s). May be null. |
occupancyPercentage | int? | Occupancy as a percentage of the vehicle capacity. May exceed 100 per the GTFS-RT specification. May be null. |
// Live crowding of the vehicle running a trip
final vehicle = trip.vehicle;
if (vehicle != null) {
print('Occupancy: ${vehicle.occupancyStatus}');
print('Occupancy %: ${vehicle.occupancyPercentage}');
print('Congestion: ${vehicle.congestionLevel}');
}
// Worst-case crowding summary over a route's fresh vehicles
final routeCrowding = route.liveCrowding;
if (routeCrowding != null) {
print('Vehicles: ${routeCrowding.vehicles}');
print('Worst occupancy: ${routeCrowding.occupancyStatus}');
}
Every field of PTCrowdingInfo is optional. Feeds and older realtime producers supply arbitrary subsets, so any combination of fields may be null. Render crowding indicators that degrade gracefully when data is absent.
Congestion Level
The PTCongestionLevel enum describes the congestion of the traffic a vehicle travels in (GTFS-RT CongestionLevel). Values outside the GTFS-RT enum map to unknown.
| Enum Case | Description |
|---|---|
unknown | Unknown congestion level. |
runningSmoothly | Running smoothly. |
stopAndGo | Stop and go. |
congestion | Congestion. |
severeCongestion | Severe congestion. |
Occupancy Status
The PTOccupancyStatus enum describes vehicle occupancy (GTFS-RT OccupancyStatus). Values above notAcceptingPassengers mean there is no usable crowding data. The scale is not strictly linear, so display the producer's state rather than interpolating.
| Enum Case | Description |
|---|---|
empty | Empty. |
manySeatsAvailable | Many seats available. |
fewSeatsAvailable | Few seats available. |
standingRoomOnly | Standing room only. |
crushedStandingRoomOnly | Crushed standing room only. |
full | Full. |
notAcceptingPassengers | Not accepting passengers. |
noDataAvailable | No usable crowding data. |
notBoardable | Not boardable (no usable crowding data). |
Stop Info
The PTStopInfo class aggregates stop-related data including agencies, stops, trips, and service alerts related to a specific public transit overlay item.
| Property | Type | Description |
|---|---|---|
agencies | List<PTAgency> | Agencies serving the selected item |
trips | List<PTTrip> | Trips in which the selected item is involved |
stops | List<PTStop> | Stops associated with the trips |
alerts | List<PTAlertInfo> | Deduplicated GTFS-RT service alerts referenced by the trips and stops. Empty when none apply. The order is not meaningful. |