OneBusAway · Example Payload

Get_Api_Where_Trips For Location.Json

TransitPublic TransitReal-TimeArrivalsDeparturesBusGTFSOpen SourceStop DataTrip PlanningService AlertsVehicle PositionsOpen Data

Get_Api_Where_Trips For Location.Json is an example object payload from OneBusAway, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparameters

Example Payload

Raw ↑ 
{
  "operationId": "get_api_where_trips-for-location.json",
  "method": "GET",
  "path": "/api/where/trips-for-location.json",
  "summary": "Retrieve trips for a given location",
  "description": "",
  "tags": [],
  "parameters": [
    {
      "name": "lat",
      "in": "query",
      "required": true,
      "schema": {
        "type": "number",
        "format": "float"
      },
      "description": "The latitude coordinate of the search center"
    },
    {
      "name": "lon",
      "in": "query",
      "required": true,
      "schema": {
        "type": "number",
        "format": "float"
      },
      "description": "The longitude coordinate of the search center"
    },
    {
      "name": "latSpan",
      "in": "query",
      "required": true,
      "schema": {
        "type": "number",
        "format": "float"
      },
      "description": "Latitude span of the search bounding box"
    },
    {
      "name": "lonSpan",
      "in": "query",
      "required": true,
      "schema": {
        "type": "number",
        "format": "float"
      },
      "description": "Longitude span of the search bounding box"
    },
    {
      "name": "includeTrip",
      "in": "query",
      "required": false,
      "schema": {
        "type": "boolean"
      },
      "description": "Whether to include full trip elements in the references section. Defaults to false."
    },
    {
      "name": "includeSchedule",
      "in": "query",
      "required": false,
      "schema": {
        "type": "boolean"
      },
      "description": "Whether to include full schedule elements in the tripDetails section. Defaults to false."
    },
    {
      "name": "time",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "format": "int64"
      },
      "description": "Specific time for the query. Defaults to the current time."
    }
  ]
}