IndexAPI Resource

GET /routers/{routerId}/index/feeds

Request Parameters
name type description constraints
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/agencies/{feedId}

Return a list of all agencies in the graph.

Request Parameters
name type description constraints
feedId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/agencies/{feedId}/{agencyId}

Return specific agency in the graph, by ID.

Request Parameters
name type description constraints
agencyId path  
feedId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/agencies/{feedId}/{agencyId}/routes

Return all routes for the specific agency.

Request Parameters
name type description constraints
agencyId path  
feedId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/stops/{stopId}

Return specific transit stop in the graph, by ID.

Request Parameters
name type description constraints
stopId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/stops

Return a list of all stops within a circle around the given coordinate.

Request Parameters
name type description constraints
detail query Choose short or long form of results. boolean
lat query double
lon query double
maxLat query double
maxLon query double
minLat query double
minLon query double
radius query double
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/stops/{stopId}/routes

Request Parameters
name type description constraints
stopId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/stops/{stopId}/patterns

Request Parameters
name type description constraints
stopId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/stops/{stopId}/stoptimes

Return upcoming vehicle arrival/departure times at the given stop.

Request Parameters
name type description default constraints
stopId path Stop ID in Agency:Stop ID format    
detail query Choose short or long form of results.   boolean
numberOfDepartures query Number of departures to fetch per pattern 2 int
refs query Include GTFS entities referenced by ID in the result.   boolean
startTime query Start time for the search. Seconds from UNIX epoch   long
timeRange query Searches forward for timeRange seconds from startTime 86400 int
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/stops/{stopId}/stoptimes/{date}

Return upcoming vehicle arrival/departure times at the given stop.

Request Parameters
name type description constraints
date path in YYYYMMDD format  
stopId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/stops/{stopId}/transfers

Return the generated transfers a stop in the graph, by stop ID

Request Parameters
name type description constraints
stopId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/routes

Return a list of all routes in the graph.

Request Parameters
name type description constraints multivalued
detail query Choose short or long form of results. boolean no
hasStop query   yes
refs query Include GTFS entities referenced by ID in the result. boolean no
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/routes/{routeId}

Return specific route in the graph, for the given ID.

Request Parameters
name type description constraints
routeId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/routes/{routeId}/patterns

Return all stop patterns used by trips on the given route.

Request Parameters
name type description constraints
routeId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/routes/{routeId}/stops

Return all stops in any pattern on a given route.

Request Parameters
name type description constraints
routeId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/routes/{routeId}/trips

Return all trips in any pattern on the given route.

Request Parameters
name type description constraints
routeId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/trips/{tripId}

Request Parameters
name type description constraints
tripId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/trips/{tripId}/stops

Request Parameters
name type description constraints
tripId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/trips/{tripId}/semanticHash

Request Parameters
name type description constraints
tripId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/trips/{tripId}/stoptimes

Request Parameters
name type description constraints
tripId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/trips/{tripId}/geometry

Return geometry for the trip as a packed coordinate sequence

Request Parameters
name type description constraints
tripId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/patterns

Request Parameters
name type description constraints
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/patterns/{patternId}

Request Parameters
name type description constraints
patternId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/patterns/{patternId}/trips

Request Parameters
name type description constraints
patternId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/patterns/{patternId}/stops

Request Parameters
name type description constraints
patternId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/patterns/{patternId}/semanticHash

Request Parameters
name type description constraints
patternId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/patterns/{patternId}/geometry

Return geometry for the pattern as a packed coordinate sequence

Request Parameters
name type description constraints
patternId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/services

List basic information about all service IDs.

Request Parameters
name type description constraints
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/services/{serviceId}

List details about a specific service ID including which dates it runs on. Replaces the old /calendar.

Request Parameters
name type description constraints
serviceId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/clusters

Return all clusters of stops.

Request Parameters
name type description constraints
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

GET /routers/{routerId}/index/clusters/{clusterId}

Return a cluster of stops by its ID.

Request Parameters
name type description constraints
clusterId path  
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Response Body
media type data type
application/json object (JSON)

POST /routers/{routerId}/index/graphql

Request Parameters
name type description constraints
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Request Body
media type data type
application/json object (JSON)
Response Body
media type data type
application/json object (JSON)

POST /routers/{routerId}/index/graphql

Request Parameters
name type description constraints
detail query Choose short or long form of results. boolean
refs query Include GTFS entities referenced by ID in the result. boolean
Request Body
media type data type
application/graphql (custom)
Response Body
media type data type
application/json object (JSON)