v2

latestSwagger 2.0Creative Commons Attribution 4.0 International2026-08-0126125128.6 KB
Search

View stops, routes and myki ticket outlets that match the search term

get/v3/search/{search_term}

Path parameters

search_termstring required

Search text (note: if search text is numeric and/or less than 3 characters, the API will only return routes)

Query parameters

route_typesinteger[]

Filter by route_type; values returned via RouteTypes API (note: stops and routes are ordered by route_types specified)

latitudenumber float

Filter by geographic coordinate of latitude

longitudenumber float

Filter by geographic coordinate of longitude

max_distancenumber float

Filter by maximum distance (in metres) from location specified via latitude and longitude parameters

include_addressesboolean

Placeholder for future development; currently unavailable

include_outletsboolean

Indicates if outlets will be returned in response (default = true)

match_stop_by_suburbboolean

Indicates whether to find stops by suburbs in the search term (default = true)

match_route_by_suburbboolean

Indicates whether to find routes by suburbs in the search term (default = true)

match_stop_by_gtfs_stop_idboolean

Indicates whether to search for stops according to a metlink stop ID (default = false)

tokenstring

Please ignore

devidstring

Your developer id

signaturestring

Authentication signature for request

Response

Stops, routes and myki ticket outlets that contain the search term (note: stops and routes are ordered by route_type by default).