v1
latestSwagger 2.02026-07-14120752.1 KBXML - Bus Position
<h4 class="text-primary">Description</h4> <p>Returns bus positions for the given route, with an optional search radius. If no parameters are specified, all bus positions are returned.</p> <p>Note that the RouteID parameter accepts only base route names and no variations, i.e.: use 10A instead of 10Av1 or 10Av2.</p> <p>Bus positions are refreshed approximately every <span style="text-decoration: line-through">20 to 30</span> 7 to 10 seconds.</p> <h4 class="text-primary">Response Elements</h4> <table class="table table-condensed table-hover"> <thead> <tr> <th class="col-md-3">Element</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>BusPositions</td> <td> Array containing bus position information (<a href= "#BusPosition">BusPositions</a>). </td> </tr> <tr> <td colspan="2"> <div class="text-primary" style="margin-top: 1em"> <a id="BusPosition" name="BusPosition">BusPosition Elements</a> </div> </td> </tr> <tr> <td>DateTime</td> <td>Date and time (Eastern Standard Time) of last position update. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T13:23:40).</td> </tr> <tr> <td>Deviation</td> <td>Deviation, in minutes, from schedule. Positive values indicate that the bus is running late while negative ones are for buses running ahead of schedule.</td> </tr> <tr> <td style="text-decoration: line-through">DirectionNum</td> <td><span class="text-danger">Deprecated.</span> Use the DirectionText for a customer-friendly description of direction.</td> </tr> <tr> <td>DirectionText</td> <td>General direction of the trip, not the bus itself (e.g.: NORTH, SOUTH, EAST, WEST).</td> </tr> <tr> <td>Lat</td> <td>Last reported Latitude of the bus.</td> </tr> <tr> <td>Lon</td> <td>Last reported Longitude of the bus.</td> </tr> <tr> <td>RouteID</td> <td>Base route name as shown on the bus. Note that the base route name could also refer to any variant, so a RouteID of 10A could refer to 10A, 10Av1, 10Av2, etc.</td> </tr> <tr> <td>TripEndTime</td> <td>Scheduled end date and time (Eastern Standard Time) of the bus's current trip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T13:17:00).</td> </tr> <tr> <td>TripHeadsign</td> <td>Destination of the bus.</td> </tr> <tr> <td>TripID</td> <td>Unique trip ID. This can be correlated with the data returned from the schedule-related methods.</td> </tr> <tr> <td>TripStartTime</td> <td>Scheduled start date and time (Eastern Standard Time) of the bus's current trip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T12:40:00).</td> </tr> <tr> <td>VehicleID</td> <td>Unique identifier for the bus. This is usually visible on the bus itself.</td> </tr> </tbody> </table>get/BusPositions
Query parameters
RouteID'70'
Bus route, e.g.: 70, 10A.
Latstring
Center point Latitude, required if Longitude and Radius are specified.
Lonstring
Center point Longitude, required if Latitude and Radius are specified.
Radiusstring
Radius (meters) to include in the search area, required if Latitude and Longitude are specified.
Response
Default response code.