GTFS-Realtime API

Download OpenAPI specification:Download

TripSearch

SearchTrips

Request Body schema:
application/json

object (GTFSRtSearch.Models.Filter)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"min_delay": 0,
"max_delay": 0,
"route_id": ["string"
],
"stop_id": ["string"
],
"stop_name": ["string"
],
"trip_id": ["string"
],
"vehicle_id": ["string"
],
"vehicle_label": ["string"
],
"trip_direction_id": [0
],
"trip_headsign": ["string"
],
"rail_environment": "string",
"rail_provider": "string"
}
}

Response samples

Content type

application/json

[{"id": "string",
"isDeleted": false,
"tripUpdate": {"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"vehicle": {"id": "",
"label": "",
"licensePlate": ""
},
"stopTimeUpdates": [{"stopSequence": 0,
"stopId": "",
"arrival": {"delay": 0,
"time": 0,
"uncertainty": 0
},
"departure": {"delay": 0,
"time": 0,
"uncertainty": 0
},
"schedule_relationship": 0
}
],
"timestamp": 0,
"delay": 0
},
"vehicle": {"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"vehicle": {"id": "",
"label": "",
"licensePlate": ""
},
"position": {"latitude": 0.1,
"longitude": 0.1,
"bearing": 0.1,
"odometer": 0.1,
"speed": 0.1
},
"currentStopSequence": 0,
"stopId": "",
"currentStatus": 0,
"timestamp": 0,
"congestion_level": 0,
"occupancy_status": 0
},
"alert": {"activePeriods": [{"start": 0,
"end": 0
}
],
"informedEntities": [{"agencyId": "",
"routeId": "",
"routeType": 0,
"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"stopId": ""
}
],
"cause": 1,
"effect": 1,
"url": {"translations": [{"text": "string",
"language": ""
}
]
},
"headerText": {"translations": [{"text": "string",
"language": ""
}
]
},
"descriptionText": {"translations": [{"text": "string",
"language": ""
}
]
},
"ttsHeaderText": {"translations": [{"text": "string",
"language": ""
}
]
},
"ttsDescriptionText": {"translations": [{"text": "string",
"language": ""
}
]
},
"severity_level": 1
}
}
]

SearchVehicles

Request Body schema:
application/json

object (GTFSRtSearch.Models.Filter)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"min_delay": 0,
"max_delay": 0,
"route_id": ["string"
],
"stop_id": ["string"
],
"stop_name": ["string"
],
"trip_id": ["string"
],
"vehicle_id": ["string"
],
"vehicle_label": ["string"
],
"trip_direction_id": [0
],
"trip_headsign": ["string"
],
"rail_environment": "string",
"rail_provider": "string"
}
}

Response samples

Content type

application/json

[{"id": "string",
"isDeleted": false,
"tripUpdate": {"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"vehicle": {"id": "",
"label": "",
"licensePlate": ""
},
"stopTimeUpdates": [{"stopSequence": 0,
"stopId": "",
"arrival": {"delay": 0,
"time": 0,
"uncertainty": 0
},
"departure": {"delay": 0,
"time": 0,
"uncertainty": 0
},
"schedule_relationship": 0
}
],
"timestamp": 0,
"delay": 0
},
"vehicle": {"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"vehicle": {"id": "",
"label": "",
"licensePlate": ""
},
"position": {"latitude": 0.1,
"longitude": 0.1,
"bearing": 0.1,
"odometer": 0.1,
"speed": 0.1
},
"currentStopSequence": 0,
"stopId": "",
"currentStatus": 0,
"timestamp": 0,
"congestion_level": 0,
"occupancy_status": 0
},
"alert": {"activePeriods": [{"start": 0,
"end": 0
}
],
"informedEntities": [{"agencyId": "",
"routeId": "",
"routeType": 0,
"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"stopId": ""
}
],
"cause": 1,
"effect": 1,
"url": {"translations": [{"text": "string",
"language": ""
}
]
},
"headerText": {"translations": [{"text": "string",
"language": ""
}
]
},
"descriptionText": {"translations": [{"text": "string",
"language": ""
}
]
},
"ttsHeaderText": {"translations": [{"text": "string",
"language": ""
}
]
},
"ttsDescriptionText": {"translations": [{"text": "string",
"language": ""
}
]
},
"severity_level": 1
}
}
]

SearchAlerts

Request Body schema:
application/json

object (GTFSRtSearch.Models.Filter)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"min_delay": 0,
"max_delay": 0,
"route_id": ["string"
],
"stop_id": ["string"
],
"stop_name": ["string"
],
"trip_id": ["string"
],
"vehicle_id": ["string"
],
"vehicle_label": ["string"
],
"trip_direction_id": [0
],
"trip_headsign": ["string"
],
"rail_environment": "string",
"rail_provider": "string"
}
}

Response samples

Content type

application/json

[{"id": "string",
"isDeleted": false,
"tripUpdate": {"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"vehicle": {"id": "",
"label": "",
"licensePlate": ""
},
"stopTimeUpdates": [{"stopSequence": 0,
"stopId": "",
"arrival": {"delay": 0,
"time": 0,
"uncertainty": 0
},
"departure": {"delay": 0,
"time": 0,
"uncertainty": 0
},
"schedule_relationship": 0
}
],
"timestamp": 0,
"delay": 0
},
"vehicle": {"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"vehicle": {"id": "",
"label": "",
"licensePlate": ""
},
"position": {"latitude": 0.1,
"longitude": 0.1,
"bearing": 0.1,
"odometer": 0.1,
"speed": 0.1
},
"currentStopSequence": 0,
"stopId": "",
"currentStatus": 0,
"timestamp": 0,
"congestion_level": 0,
"occupancy_status": 0
},
"alert": {"activePeriods": [{"start": 0,
"end": 0
}
],
"informedEntities": [{"agencyId": "",
"routeId": "",
"routeType": 0,
"trip": {"tripId": "",
"routeId": "",
"directionId": 0,
"startTime": "",
"startDate": "",
"schedule_relationship": 0
},
"stopId": ""
}
],
"cause": 1,
"effect": 1,
"url": {"translations": [{"text": "string",
"language": ""
}
]
},
"headerText": {"translations": [{"text": "string",
"language": ""
}
]
},
"descriptionText": {"translations": [{"text": "string",
"language": ""
}
]
},
"ttsHeaderText": {"translations": [{"text": "string",
"language": ""
}
]
},
"ttsDescriptionText": {"translations": [{"text": "string",
"language": ""
}
]
},
"severity_level": 1
}
}
]

GTFS-Realtime API

TripSearch

SearchTrips

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

SearchVehicles

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

SearchAlerts

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json