---
title: "View stops, routes and myki ticket outlets that match the search term"
method: GET
path: "/v3/search/{search_term}"
tags: ["Search"]
---

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

`GET /v3/search/{search_term}`

## Path parameters

- `search_term` string, required

## Query parameters

- `route_types` integer[]
- `latitude` number, float
- `longitude` number, float
- `max_distance` number, float
- `include_addresses` boolean
- `include_outlets` boolean
- `match_stop_by_suburb` boolean
- `match_route_by_suburb` boolean
- `match_stop_by_gtfs_stop_id` boolean
- `token` string
- `devid` string
- `signature` string

## Response `200`

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

- V3SearchResult
  - `stops` V3ResultStop[] — Train stations, tram stops, bus stops, regional coach stops or Night Bus stops
    - `stop_distance` number, float — Distance of stop from input location (in metres); returns 0 if no location is input
    - `stop_suburb` string — suburb of stop
    - `route_type` integer — Transport mode identifier
    - `routes` V3ResultRoute[] — List of routes travelling through the stop
      - `route_name` string — Name of route
      - `route_number` string — Route number presented to public (nb. not route_id)
      - `route_type` integer — Transport mode identifier
      - `route_id` integer — Route identifier
      - `route_gtfs_id` string — GTFS Identifer of the route
      - `route_service_status` V3RouteServiceStatus
        - `description` string
        - `timestamp` string, date-time
    - `stop_latitude` number, float — Geographic coordinate of latitude at stop
    - `stop_longitude` number, float — Geographic coordinate of longitude at stop
    - `stop_sequence` integer — Sequence of the stop on the route/run; return 0 when route_id or run_id not specified. Order ascendingly by this field (when non zero) to get physical order (earliest first) of stops on the route_id/run_id.
    - `stop_id` integer — Stop identifier
    - `stop_name` string — Name of stop
    - `stop_landmark` string — Landmark in proximity of stop
  - `routes` V3ResultRoute[] — Train lines, tram routes, bus routes, regional coach routes, Night Bus routes
    - `route_name` string — Name of route
    - `route_number` string — Route number presented to public (nb. not route_id)
    - `route_type` integer — Transport mode identifier
    - `route_id` integer — Route identifier
    - `route_gtfs_id` string — GTFS Identifer of the route
    - `route_service_status` V3RouteServiceStatus
      - `description` string
      - `timestamp` string, date-time
  - `outlets` V3ResultOutlet[] — myki ticket outlets
    - `outlet_distance` number, float — Distance of outlet from input location (in metres); returns 0 if no location is input
    - `outlet_slid_spid` string — The SLID / SPID
    - `outlet_name` string — The location name of the outlet
    - `outlet_business` string — The business name of the outlet
    - `outlet_latitude` number, float — Geographic coordinate of latitude at outlet
    - `outlet_longitude` number, float — Geographic coordinate of longitude at outlet
    - `outlet_suburb` string — The city/municipality the outlet is in
    - `outlet_postcode` integer — The postcode for the outlet
    - `outlet_business_hour_mon` string — The business hours on Monday
    - `outlet_business_hour_tue` string — The business hours on Tuesday
    - `outlet_business_hour_wed` string — The business hours on Wednesday
    - `outlet_business_hour_thur` string — The business hours on Thursday
    - `outlet_business_hour_fri` string — The business hours on Friday
    - `outlet_business_hour_sat` string — The business hours on Saturday
    - `outlet_business_hour_sun` string — The business hours on Sunday
    - `outlet_notes` string — Any additional notes for the outlet such as 'Buy pre-loaded myki cards only'. May be null/empty.
  - `status` V3Status
    - `version` string — API Version number
    - `health` 0 | 1 — API system health status (0=offline, 1=online)

## Other responses

- `400` — Invalid Request
- `403` — Access Denied

---

[API](https://skmtc.dev/gov/apis/ptv-timetable-api-version-3.md) · [All operations](https://skmtc.dev/gov/apis/ptv-timetable-api-version-3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gov/ptv-timetable-api-version-3/revisions/fe82d30d47ea/schema)