IndexAPI

The following resources are applicable:

• /routers/{routerId}/index/agencies
• /routers/{routerId}/index/agencies/{agencyId}
• /routers/{routerId}/index/agencies/{agencyId}/routes
• /routers/{routerId}/index/clusters
• /routers/{routerId}/index/clusters/{clusterId}
• /routers/{routerId}/index/patterns
• /routers/{routerId}/index/patterns/{patternId}
• /routers/{routerId}/index/patterns/{patternId}/geometry
• /routers/{routerId}/index/patterns/{patternId}/semanticHash
• /routers/{routerId}/index/patterns/{patternId}/stops
• /routers/{routerId}/index/patterns/{patternId}/trips
• /routers/{routerId}/index/routes
• /routers/{routerId}/index/routes/{routeId}
• /routers/{routerId}/index/routes/{routeId}/patterns
• /routers/{routerId}/index/routes/{routeId}/stops
• /routers/{routerId}/index/routes/{routeId}/trips
• /routers/{routerId}/index/services
• /routers/{routerId}/index/services/{serviceId}
• /routers/{routerId}/index/stops
• /routers/{routerId}/index/stops/{stopId}
• /routers/{routerId}/index/stops/{stopId}/patterns
• /routers/{routerId}/index/stops/{stopId}/routes
• /routers/{routerId}/index/stops/{stopId}/stoptimes
• /routers/{routerId}/index/stops/{stopId}/stoptimes/{date}
• /routers/{routerId}/index/stops/{stopId}/transfers
• /routers/{routerId}/index/trips/{tripId}
• /routers/{routerId}/index/trips/{tripId}/geometry
• /routers/{routerId}/index/trips/{tripId}/semanticHash
• /routers/{routerId}/index/trips/{tripId}/stops
• /routers/{routerId}/index/trips/{tripId}/stoptimes

/routers/{routerId}/index/agencies

GET

Return a list of all agencies in the graph.

Parameters

name	description	type	default
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Return specific agency in the graph, by ID.

Parameters

name	description	type	default
agencyId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Return all routes for the specific agency.

Parameters

name	description	type	default
agencyId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

/routers/{routerId}/index/clusters

GET

Return all clusters of stops.

Parameters

name	description	type	default
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Return a cluster of stops by its ID.

Parameters

name	description	type	default
clusterId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

/routers/{routerId}/index/patterns

GET

Parameters

name	description	type	default
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
patternId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Return geometry for the pattern as a packed coordinate sequence

Parameters

name	description	type	default
patternId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
patternId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
patternId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
patternId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

/routers/{routerId}/index/routes

GET

Return a list of all routes in the graph.

Parameters

name	description	type	default
hasStop	(no documentation provided)	query
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

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

Parameters

name	description	type	default
routeId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

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

Parameters

name	description	type	default
routeId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Return all stops in any pattern on a given route.

Parameters

name	description	type	default
routeId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Return all trips in any pattern on the given route.

Parameters

name	description	type	default
routeId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

/routers/{routerId}/index/services

GET

List basic information about all service IDs.

Parameters

name	description	type	default
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

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

Parameters

name	description	type	default
serviceId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

/routers/{routerId}/index/stops

GET

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

Parameters

name	description	type	default
minLat	(no documentation provided)	query
minLon	(no documentation provided)	query
maxLat	(no documentation provided)	query
maxLon	(no documentation provided)	query
lat	(no documentation provided)	query
lon	(no documentation provided)	query
radius	(no documentation provided)	query
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Return specific transit stop in the graph, by ID.

Parameters

name	description	type	default
stopId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
stopId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
stopId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

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

Parameters

name	description	type	default
stopId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

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

Parameters

name	description	type	default
stopId	(no documentation provided)	path
date	in YYYYMMDD format	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

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

Parameters

name	description	type	default
stopId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
tripId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Return geometry for the trip as a packed coordinate sequence

Parameters

name	description	type	default
tripId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
tripId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
tripId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

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

GET

Parameters

name	description	type	default
tripId	(no documentation provided)	path
detail	Choose short or long form of results.	query
refs	Include GTFS entities referenced by ID in the result.	query

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)