PTV Timetable API

https://timetableapi.ptv.vic.gov.au/swagger/docs/v3
Admin
PTV Timetable API provides direct access to Public Transport Victoria's public transport timetable...
Tokens:31,312
Snippets:147
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get All Routes Request

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

An example of a request to retrieve all routes, with optional query parameters for filtering by route type and name. Authentication parameters like developer ID and signature are also included.

```http
GET /v3/routes?route_types={0,1,2,3,4}&route_name={partial_route_name} HTTP/1.1
Host: timetableapi.ptv.vic.gov.au
Authorization: Bearer YOUR_ACCESS_TOKEN

# Parameters:
# route_types: Filter by route_type (0=Train, 1=Tram, 2=Bus, 3=V/Line, 4=Night Bus)
# route_name: Filter by name of route (accepts partial route name matches)
# token: Please ignore
# devid: Your developer id
# signature: Authentication signature for request
```

--------------------------------

### Get Runs by Route ID and Type (JSON Example)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Example JSON response structure for fetching runs associated with a specific route ID and route type. Includes details on vehicle position, descriptor, and interchange information.

```json
{
  "express_stop_count": 0,
  "vehicle_position": {
    "latitude": 0,
    "longitude": 0,
    "easting": 0,
    "northing": 0,
    "direction": "string",
    "bearing": 0,
    "supplier": "string",
    "datetime_utc": "2025-09-02T05:45:06.689Z",
    "expiry_time": "2025-09-02T05:45:06.689Z"
  },
  "vehicle_descriptor": {
    "operator": "string",
    "id": "string",
    "low_floor": true,
    "air_conditioned": true,
    "description": "string",
    "supplier": "string",
    "length": "string"
  },
  "geopath": [
    {}
  ],
  "interchange": {
    "feeder": {
      "run_ref": "string",
      "route_id": 0,
      "stop_id": 0,
      "advertised": true,
      "direction_id": 0,
      "destination_name": "string"
    },
    "distributor": {
      "run_ref": "string",
      "route_id": 0,
      "stop_id": 0,
      "advertised": true,
      "direction_id": 0,
      "destination_name": "string"
    }
  },
  "run_note": "string",
  "externalService": 0
}
```

--------------------------------

### V3.Status Model and Example

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the V3.Status object, which provides API version and health status. The example illustrates the expected format for this metadata within an error response.

```json
{
  "version": "string",
  "health": 0
}
```

--------------------------------

### Example API Request (Curl)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Illustrates how to make a request to the API using curl, including the endpoint and necessary parameters like direction ID, token, developer ID, and signature.

```bash
curl -X GET "https://timetableapi.ptv.vic.gov.au/v3/directions/{direction_id}?token=YOUR_TOKEN&devid=YOUR_DEVID&signature=YOUR_SIGNATURE"
```

--------------------------------

### PTV API v3 Stop Facilities Request

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Example of a request to view facilities at a specific stop, specifying the stop ID and route type.

```http
GET /v3/stops/{stop_id}/route_type/{route_type}
```

--------------------------------

### V3.ErrorResponse Model and Example

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure for error responses, including a message and status details. The status includes API version and health. Example shows a typical JSON payload for an error.

```json
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### V3.ErrorResponse Model and Example

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure of an error response from the API, including a user-friendly message and status metadata. The example shows a typical JSON payload for an invalid request.

```json
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### PTV Timetable API v3 - Get Run Parameters

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

This table outlines the parameters available for the GET /v3/runs/{run_ref} endpoint, including route ID, route type, expansion options, date filtering, interchange inclusion, and authentication details.

```json
{
  "route_id": "",
  "route_type": "0 1 2 3 4",
  "expand": "0 1 2 2147483647",
  "date_utc": "",
  "include_advertised_interchange": "true false",
  "token": "",
  "devid": "",
  "signature": ""
}
```

--------------------------------

### Get Specific Route Request

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

An example of a request to retrieve details for a specific route using its ID. This endpoint allows fetching information about a single route.

```http
GET /v3/routes/{route_id} HTTP/1.1
Host: timetableapi.ptv.vic.gov.au
Authorization: Bearer YOUR_ACCESS_TOKEN

# Parameters:
# route_id: Route identifier
```

--------------------------------

### V3 Error Response Model and Example

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure for error responses, including a message and status object. The status object contains the API version and health status. An example JSON payload is provided.

```json
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Get Stops by Location - Example Response (200)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

This JSON structure represents a successful response when querying for stops near a specific location. It includes an array of stop objects, each containing details like distance, name, ID, route type, coordinates, and disruption information.

```json
{
  "stops": [
    {
      "disruption_ids": [
        0
      ],
      "stop_distance": 0,
      "stop_suburb": "string",
      "stop_name": "string",
      "stop_id": 0,
      "route_type": 0,
      "routes": [
        {}
      ],
      "stop_latitude": 0,
      "stop_longitude": 0,
      "stop_landmark": "string",
      "stop_sequence": 0
    }
  ],
  "disruptions": {},
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### V3.Disruption Model

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details a single disruption event, including its ID, title, URL, description, status, type, publication and update timestamps, start and end dates, and associated routes and stops.

```json
{
  "disruption_id": 0,
  "title": "string",
  "url": "string",
  "description": "string",
  "disruption_status": "string",
  "disruption_type": "string",
  "published_on": "2025-09-02T05:45:06.621Z",
  "last_updated": "2025-09-02T05:45:06.621Z",
  "from_date": "2025-09-02T05:45:06.621Z",
  "to_date": "2025-09-02T05:45:06.621Z",
  "routes": [
    {
      "route_type": 0,
      "route_id": 0,
      "route_name": "string",
      "route_number": "string",
      "route_gtfs_id": "string",
      "direction": {
        "route_direction_id": 0,
        "direction_id": 0,
        "direction_name": "string",
        "service_time": "string"
      }
    }
  ],
  "stops": [
    {
      "stop_id": 0,
      "stop_name": "string"
    }
  ],
  "colour": "string",
  "display_on_board": true,
  "display_status": true
}
```

--------------------------------

### Get Disruption Modes - PTV API v3

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves all disruption modes supported by the PTV API v3. Requires a developer ID, token, and signature for authentication. Returns a list of disruption modes with their names and identifiers.

```json
{
  "disruption_modes": [
    {
      "disruption_mode_name": "string",
      "disruption_mode": 0
    }
  ],
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Get Directions for a Route

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves the directions of travel for a specified route. Requires the route ID. Optional parameters include authentication tokens and developer IDs.

```http
GET /v3/directions/route/{route_id} HTTP/1.1
Host: timetableapi.ptv.vic.gov.au
Content-Type: application/json

{
  "token": "YOUR_TOKEN",
  "devid": "YOUR_DEVID",
  "signature": "YOUR_SIGNATURE"
}
```

--------------------------------

### Get Stops by Location - Access Denied Response (403)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

This JSON structure represents an access denied error response, indicating that the request could not be authenticated or authorized. It provides an error message and API status details.

```json
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Get Departures by Route and Stop

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves departure information for a specific route from a given stop. Requires route type, route ID, and stop ID as path parameters. Optional query parameters allow filtering by date, including cancelled services, and expanding results.

```http
GET /v3/departures/route_type/{route_type}/stop/{stop_id}/route/{route_id}
```

--------------------------------

### PTV API v3 Parameters

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

This snippet lists the parameters available for querying the PTV API v3, including path and query parameters for departures and other endpoints. It specifies parameter names, types, and descriptions.

```json
{
  "run_ref": {
    "description": "The run_ref is the identifier of a run as returned by the departures/_and runs/_ endpoints. WARNING, run_id is deprecated. Use run_ref instead. ",
    "parameterType": "path",
    "dataType": "string"
  },
  "route_type": {
    "description": "Number identifying transport mode; values returned via RouteTypes API",
    "parameterType": "path",
    "dataType": "integer",
    "values": [0, 1, 2, 3, 4]
  },
  "expand": {
    "description": "List of objects to be returned in full (i.e. expanded) - options include: All, Stop, Route, Run, Direction, Disruption, VehiclePosition, VehicleDescriptor and None. Default is Disruption. Run must be expanded to receive VehiclePosition and VehicleDescriptor information.",
    "parameterType": "query",
    "dataType": "Array[integer]",
    "values": [0, 1, 2, 3, 4, 5, 6, 7, 2147483647]
  },
  "stop_id": {
    "description": "Filter by stop_id; values returned by Stops API",
    "parameterType": "query",
    "dataType": "integer"
  },
  "date_utc": {
    "description": "Filter by the date and time of the request (ISO 8601 UTC format) (default = current date and time)",
    "parameterType": "query",
    "dataType": "date-time"
  },
  "include_skipped_stops": {
    "description": "Include any skipped stops in a stopping pattern. Defaults to false.",
    "parameterType": "query",
    "dataType": "boolean",
    "values": ["true", "false"]
  },
  "include_geopath": {
    "description": "Indicates if geopath data will be returned (default = false)",
    "parameterType": "query",
    "dataType": "boolean",
    "values": ["true", "false"]
  },
  "include_advertised_interchange": {
    "description": "Indicates whether data related to interchanges should be included in the response (default = false) When set to true, this parameter enables API clients to retrieve additional exchange information (stops, routes, runs, directions and disruptions) in a single call instead of making multiple requests",
    "parameterType": "query",
    "dataType": "boolean",
    "values": ["true", "false"]
  },
  "token": {
    "description": "Please ignore",
    "parameterType": "query",
    "dataType": "string"
  },
  "devid": {
    "description": "Your developer id",
    "parameterType": "query",
    "dataType": "string"
  },
  "signature": {
    "description": "Authentication signature for request",
    "parameterType": "query",
    "dataType": "string"
  }
}
```

--------------------------------

### PTV Timetable API v3 Base URL Structure

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure for accessing the PTV Timetable API v3, including the base URL, version number, API name, and query string.

```text
base URL / version number / API name / query string
```

--------------------------------

### API Parameters for Disruption Queries

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the parameters available for querying disruption information, including route and stop identifiers, disruption status filters, and authentication credentials.

```text
Parameters:
route_id: Identifier of route; values returned by Routes API - v3/routes
stop_id: Identifier of stop; values returned by Stops API - v3/stops
disruption_status: Filter by status of disruption (0 or 1)
token: Please ignore
devid: Your developer id
signature: Authentication signature for request
```

--------------------------------

### Search for Stops, Routes, and Outlets

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Searches for public transport stops, routes, and myki ticket outlets based on a provided search term. This endpoint helps users find relevant transport information.

```http
GET /v3/search/{search_term}
```

--------------------------------

### V3.Run Model Details

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the fields within the V3.Run model, representing an individual trip or service of a route. Includes identifiers, route information, status, and sequence.

```json
{
  "run_id": 0, 
  "run_ref": "string",
  "route_id": 0,
  "route_type": 0,
  "final_stop_id": 0,
  "destination_name": "string",
  "status": "string",
  "direction_id": 0,
  "run_sequence": 0,
  "express_stop_count": 0,
  "vehicle_position": "V3.VehiclePosition",
  "vehicle_descriptor": "V3.VehicleDescriptor",
  "geopath": "Array[Inline Model 1]",
  "interchange": "V3.Interchange",
  "run_note": "string",
  "externalService": "integer"
}
```

--------------------------------

### Get Route Types (Status 200)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves all route types (transport modes) and their corresponding names. The response model V3.RouteTypesResponse contains a list of route types and API status.

```json
{
  "route_types": [
    {
      "route_type_name": "string",
      "route_type": 0
    }
  ],
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Get Vehicle Positions

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves real-time vehicle positions for a given route type and run reference. Optional parameters allow expanding the response to include vehicle descriptors and geopath data.

```http
GET /v3/vehiclepositions?run_ref={run_ref}&route_type={route_type}&expand={expand}&date_utc={date_utc}&include_geopath={include_geopath}&token={token}&devid={devid}&signature={signature}
```

--------------------------------

### V3.InterchangeRun Object

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Describes the V3.InterchangeRun object, which provides details for interchange connections. It includes run references, route and stop IDs, advertising status, direction, and destination name.

```json
{
  "run_ref": "string (optional)",
  "route_id": "integer (optional)",
  "stop_id": "integer (optional)",
  "advertised": "boolean (optional)",
  "direction_id": "integer (optional)",
  "destination_name": "string (optional)"
}
```

--------------------------------

### Get Stops by Location - Invalid Request Response (400)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

This JSON structure details an error response for an invalid request. It includes a user-friendly error message and status information about the API's health and version.

```json
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### PTV Timetable API v3 - Runs Endpoint Parameters

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the parameters available for the /v3/runs/route/{route_id}/route_type/{route_type} endpoint. Includes path and query parameters for filtering and expanding data.

```http
Parameter | Value | Description | Parameter Type | Data Type 
---|---|---|---|---
route_id |  | **Identifier of route; values returned by Routes API - v3/routes. ** | path | integer  
expand |  0  1  2  2147483647  |  List of objects to be returned in full (i.e. expanded) - options include: All, VehiclePosition, VehicleDescriptor, or None. Default is None. | query | Array[integer]  
date_utc |  |  Filter by the date and time of the request (ISO 8601 UTC format) (default = current date and time) | query |  date-time  
include_advertised_interchange |  true  false  |  Indicates whether data related to interchanges should be included in the response (default = false). When set to true, this parameter enables API clients to retrieve additional exchange information (stops, routes, runs, directions and disruptions) in a single call instead of making multiple requests | query | boolean  
token |  |  Please ignore | query |  string  
devid |  |  Your developer id | query |  string  
signature |  |  Authentication signature for request | query |  string  
```

--------------------------------

### V3.InterchangeRun Model Details

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the fields within the V3.InterchangeRun model, used to describe a run involved in an interchange. Includes run reference, route, stop, direction, and destination.

```json
{
  "run_ref": "string",
  "route_id": "integer",
  "stop_id": "integer",
  "advertised": "boolean",
  "direction_id": "integer",
  "destination_name": "string"
}
```

--------------------------------

### Error Response (Access Denied)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

This JSON structure details an 'Access Denied' error response from the API. It provides a message explaining the access issue and includes the API status information.

```json
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Get Route Details (Status 200)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves the route name and number for a specified route ID. Includes optional geopath data and filtering by date. The response model V3.RouteResponse contains route details and API status.

```json
{
  "route": {
    "route_service_status": {
      "description": "string",
      "timestamp": "2025-09-02T05:45:06.682Z"
    },
    "route_type": 0,
    "route_id": 0,
    "route_name": "string",
    "route_number": "string",
    "route_gtfs_id": "string",
    "geopath": [
      {}
    ]
  },
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Estimate Fare by Zone - PTV API v3

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Estimates a fare based on the minimum and maximum zones provided. Requires authentication parameters like developer ID, token, and signature.

```http
GET /v3/fare_estimate/min_zone/{minZone}/max_zone/{maxZone}
```

--------------------------------

### API Status Information

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Provides the status of the API, including version information and a health check indicator.

```json
{
  "version": "string",
  "health": 0
}
```

--------------------------------

### Get Routes for a Direction (v3)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves all routes associated with a specific direction of travel. The response includes a list of directions, each with its description, ID, name, route ID, and route type. It also provides API status metadata.

```json
{
  "directions": [
    {
      "route_direction_description": "string",
      "direction_id": 0,
      "direction_name": "string",
      "route_id": 0,
      "route_type": 0
    }
  ],
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Get Stops by Route and Route Type

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves a list of all stops associated with a specific route and transport mode. Requires route ID and route type as path parameters, along with optional query parameters to filter or include additional stop details.

```http
GET /v3/stops/route/{route_id}/route_type/{route_type}
```

--------------------------------

### PTV Timetable API v3 - Error Response Messages

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the possible HTTP status codes and their corresponding error response models for the PTV Timetable API v3. Covers invalid requests and access denied scenarios.

```http
HTTP Status Code | Reason | Response Model | Headers  
---|---|---|---
400 |  Invalid Request | 
        * Model
        * Example Value
V3.ErrorResponse { message (string, optional): Error message , status (V3.Status, optional): API Status / Metadata }

V3.Status { version (string, optional): API Version number , health (integer, optional): API system health status (0=offline, 1=online) = ['0', '1'] | integer  
---
Enum: | 0, 1  
}
```
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```
  
403 |  Access Denied | 
        * Model
        * Example Value
V3.ErrorResponse { message (string, optional): Error message , status (V3.Status, optional): API Status / Metadata }

V3.Status { version (string, optional): API Version number , health (integer, optional): API system health status (0=offline, 1=online) = ['0', '1'] | integer  
---
Enum: | 0, 1  
}
```
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```
  
Hide Response
```

--------------------------------

### Get Run Information by Run Reference and Route Type

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves the trip or service run details for a given run reference and route type. This endpoint allows for optional inclusion of geopath data, expanded vehicle details, and advertised interchange information.

```http
GET /v3/runs/{run_ref}/route_type/{route_type} HTTP/1.1
Host: timetableapi.ptv.vic.gov.au
Accept: application/json

# Query Parameters:
# include_geopath: boolean (optional) - Indicates if geopath data will be returned (default = false)
# expand: Array[integer] (optional) - List of objects to be returned in full (e.g., VehiclePosition, VehicleDescriptor). Default is None.
# date_utc: date-time (optional) - Filter by the date and time of the request (ISO 8601 UTC format) (default = current date and time)
# include_advertised_interchange: boolean (optional) - Indicates whether data related to interchanges should be included (default = false)
# token: string (query) - Your developer token
# devid: string (query) - Your developer ID
# signature: string (query) - Authentication signature for request
```

--------------------------------

### V3.Run Object Details

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the fields within the V3.Run object, representing individual trips or services. It includes identifiers, route information, status, sequence, and optional vehicle and geopath data.

```json
{
  "run_id": "integer (optional, read only)",
  "run_ref": "string (optional)",
  "route_id": "integer (optional)",
  "route_type": "integer (optional)",
  "final_stop_id": "integer (optional)",
  "destination_name": "string (optional)",
  "status": "string (optional)",
  "direction_id": "integer (optional)",
  "run_sequence": "integer (optional)",
  "express_stop_count": "integer (optional)",
  "vehicle_position": "V3.VehiclePosition (optional)",
  "vehicle_descriptor": "V3.VehicleDescriptor (optional)",
  "geopath": "Array[Inline Model 1] (optional)",
  "interchange": "V3.Interchange (optional)",
  "run_note": "string (optional)",
  "externalService": "integer (optional) = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10']"
}
```

--------------------------------

### Get Outlets by Location (JSON Response)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

This snippet shows the structure of a successful JSON response when querying for ticket outlets near a specific location. It includes an array of outlets, each with details like distance, name, address, and business hours, as well as the API status.

```json
{
  "outlets": [
    {
      "outlet_distance": 0,
      "outlet_slid_spid": "string",
      "outlet_name": "string",
      "outlet_business": "string",
      "outlet_latitude": 0,
      "outlet_longitude": 0,
      "outlet_suburb": "string",
      "outlet_postcode": 0,
      "outlet_business_hour_mon": "string",
      "outlet_business_hour_tue": "string",
      "outlet_business_hour_wed": "string",
      "outlet_business_hour_thur": "string",
      "outlet_business_hour_fri": "string",
      "outlet_business_hour_sat": "string",
      "outlet_business_hour_sun": "string",
      "outlet_notes": "string"
    }
  ],
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Query Parameters for Disruption Data

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the available query parameters for filtering disruption data. Includes stop ID, disruption status, and authentication credentials.

```json
{
  "stop_id": "",
  "disruption_status": "0 1",
  "token": "",
  "devid": "",
  "signature": ""
}
```

--------------------------------

### Get Routes for a Direction with Type (v3)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves all routes of a particular type for a specified direction of travel. This endpoint allows filtering routes based on their type within a given direction. The response structure is similar to the general direction endpoint, providing route details and API status.

```json
{
  "directions": [
    {
      "route_direction_description": "string",
      "direction_id": 0,
      "direction_name": "string",
      "route_id": 0,
      "route_type": 0
    }
  ],
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### PTV Timetable API v3 Departures by Route and Stop

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Retrieves departure information for all routes from a specific stop. This requires specifying the route type and stop ID in the URL.

```http
GET /v3/departures/route_type/{route_type}/stop/{stop_id}
```

--------------------------------

### V3.Disruption Model

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Represents disruption information applicable to relevant routes or stops. Includes details like ID, title, URL, description, status, type, dates, and associated routes and stops.

```json
{
  "disruption_id": "integer optional",
  "title": "string optional",
  "url": "string optional",
  "description": "string optional",
  "disruption_status": "string optional",
  "disruption_type": "string optional",
  "published_on": "string optional",
  "last_updated": "string optional",
  "from_date": "string optional",
  "to_date": "string optional",
  "routes": "Array[V3.DisruptionRoute] optional",
  "stops": "Array[V3.DisruptionStop] optional",
  "colour": "string optional",
  "display_on_board": "boolean optional",
  "display_status": "boolean optional"
}
```

--------------------------------

### PTV API v3 Search Result Structure

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure of the V3.SearchResult model, which encompasses stops, routes, and myki ticket outlets. It also details the nested structures for V3.ResultStop, V3.ResultRoute, V3.ResultOutlet, V3.Status, and V3.RouteServiceStatus, including optional fields and their descriptions.

```Swagger
V3.SearchResult {
stops (Array[V3.ResultStop], optional):
Train stations, tram stops, bus stops, regional coach stops or Night Bus stops
,
routes (Array[V3.ResultRoute], optional):
Train lines, tram routes, bus routes, regional coach routes, Night Bus routes
,
outlets (Array[V3.ResultOutlet], optional):
myki ticket outlets
,
status (V3.Status, optional):
API Status / Metadata
}

V3.ResultStop {
stop_distance (number, optional):
Distance of stop from input location (in metres); returns 0 if no location is input
,
stop_suburb (string, optional):
suburb of stop
,
route_type (integer, optional):
Transport mode identifier
,
routes (Array[V3.ResultRoute], optional):
List of routes travelling through the stop
,
stop_latitude (number, optional):
Geographic coordinate of latitude at stop
,
stop_longitude (number, optional):
Geographic coordinate of longitude at stop
,
stop_sequence (integer, optional):
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, optional):
Stop identifier
,
stop_name (string, optional):
Name of stop
,
stop_landmark (string, optional):
Landmark in proximity of stop
}

V3.ResultRoute {
route_name (string, optional):
Name of route
,
route_number (string, optional):
Route number presented to public (nb. not route_id)
,
route_type (integer, optional):
Transport mode identifier
,
route_id (integer, optional):
Route identifier
,
route_gtfs_id (string, optional):
GTFS Identifer of the route
,
route_service_status (V3.RouteServiceStatus, optional):
Service status for the route (indicates disruptions)
}

V3.ResultOutlet {
outlet_distance (number, optional):
Distance of outlet from input location (in metres); returns 0 if no location is input
,
outlet_slid_spid (string, optional):
The SLID / SPID
,
outlet_name (string, optional):
The location name of the outlet
,
outlet_business (string, optional):
The business name of the outlet
,
outlet_latitude (number, optional):
Geographic coordinate of latitude at outlet
,
outlet_longitude (number, optional):
Geographic coordinate of longitude at outlet
,
outlet_suburb (string, optional):
The city/municipality the outlet is in
,
outlet_postcode (integer, optional):
The postcode for the outlet
,
outlet_business_hour_mon (string, optional):
The business hours on Monday
,
outlet_business_hour_tue (string, optional):
The business hours on Tuesday
,
outlet_business_hour_wed (string, optional):
The business hours on Wednesday
,
outlet_business_hour_thur (string, optional):
The business hours on Thursday
,
outlet_business_hour_fri (string, optional):
The business hours on Friday
,
outlet_business_hour_sat (string, optional):
The business hours on Saturday
,
outlet_business_hour_sun (string, optional):
The business hours on Sunday
,
outlet_notes (string, optional):
Any additional notes for the outlet such as 'Buy pre-loaded myki cards only'. May be null/empty.
}

V3.Status {
version (string, optional):
API Version number
,
health (integer, optional):
API system health status (0=offline, 1=online)
= ['0', '1'] integer
---
Enum: | 0, 1
}

V3.RouteServiceStatus {
description (string, optional),
timestamp (string, optional)
}
```

--------------------------------

### V3 Departures Response Structure (JSON)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure of the JSON response for service departures from a specified stop. Includes details on timetabled and real-time departures, stop information, route details, run information, directions, disruptions, and API status.

```json
{
  "departures": [
    {
      "stop_id": 0,
      "route_id": 0,
      "run_id": 0,
      "run_ref": "string",
      "direction_id": 0,
      "disruption_ids": [
        0
      ],
      "scheduled_departure_utc": "2025-09-02T05:45:06.581Z",
      "estimated_departure_utc": "2025-09-02T05:45:06.581Z",
      "at_platform": true,
      "platform_number": "string",
      "flags": "string",
      "departure_sequence": 0,
      "departure_note": "string"
    }
  ],
  "stops": {},
  "routes": {},
  "runs": {},
  "directions": {},
  "disruptions": {},
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### V3.Status Model Details

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the fields within the V3.Status model, providing API version and system health status. Health is indicated by 0 for offline and 1 for online.

```json
{
  "version": "string",
  "health": "integer"
}
```

--------------------------------

### API Query Parameters for Disruptions

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

This section details the query parameters available for filtering disruption information. You can filter by route types, disruption modes, and disruption status. Authentication requires a developer ID and signature.

```http
GET /v3/disruptions?route_types={route_types}&disruption_modes={disruption_modes}&disruption_status={disruption_status}&token={token}&devid={devid}&signature={signature}
```

--------------------------------

### V3 Route Response Model

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Represents the response for retrieving route information, including route details and API status. Route details encompass service status, type, ID, name, GTFS ID, and geopath.

```json
{
  "route": {
    "route_service_status": {
      "description": "string",
      "timestamp": "2025-09-02T05:45:06.679Z"
    },
    "route_type": 0,
    "route_id": 0,
    "route_name": "string",
    "route_number": "string",
    "route_gtfs_id": "string",
    "geopath": [
      {}
    ]
  },
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Status Model

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Represents the status of the API, including its version and health.

```json
{
  "version": "string",
  "health": 0
}
```

--------------------------------

### V3.VehicleDescriptor Model Details

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the fields within the V3.VehicleDescriptor model, providing information about the vehicle's operator, type, and features like low floor or air conditioning.

```json
{
  "operator": "string",
  "id": "string",
  "low_floor": "boolean",
  "air_conditioned": "boolean",
  "description": "string",
  "supplier": "string",
  "length": "string"
}
```

--------------------------------

### Disruption Data Structure

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure for disruption information, including details like disruption ID, title, URL, description, status, type, publication and update times, date ranges, associated routes and stops, and display settings.

```json
{
  "disruption_id": 0,
  "title": "string",
  "url": "string",
  "description": "string",
  "disruption_status": "string",
  "disruption_type": "string",
  "published_on": "2025-09-02T05:45:06.636Z",
  "last_updated": "2025-09-02T05:45:06.636Z",
  "from_date": "2025-09-02T05:45:06.636Z",
  "to_date": "2025-09-02T05:45:06.636Z",
  "routes": [
    {
      "route_type": 0,
      "route_id": 0,
      "route_name": "string",
      "route_number": "string",
      "route_gtfs_id": "string",
      "direction": {
        "route_direction_id": 0,
        "direction_id": 0,
        "direction_name": "string",
        "service_time": "string"
      }
    }
  ],
  "stops": [
    {
      "stop_id": 0,
      "stop_name": "string"
    }
  ],
  "colour": "string",
  "display_on_board": true,
  "display_status": true
}
```

--------------------------------

### V3.PatternDeparture Model

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details a specific departure for a run, including skipped stops, stop and route identifiers, departure times (scheduled and estimated), platform information, and departure sequence.

```json
{
  "skipped_stops": "Array[V3.StopModel] optional",
  "stop_id": "integer optional",
  "route_id": "integer optional",
  "run_id": "integer optional, read only",
  "run_ref": "string optional",
  "direction_id": "integer optional",
  "disruption_ids": "Array[integer] optional",
  "scheduled_departure_utc": "string optional",
  "estimated_departure_utc": "string optional",
  "at_platform": "boolean optional",
  "platform_number": "string optional",
  "flags": "string optional",
  "departure_sequence": "integer optional",
  "departure_note": "string optional"
}
```

--------------------------------

### V3.Status Object

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Describes the V3.Status object, which contains metadata about the API's version and health. The 'version' field indicates the API version number, and the 'health' field shows the system's online status (0 for offline, 1 for online).

```json
{
"version": "string, optional",
"health": "integer, optional"
}
```

--------------------------------

### V3.Interchange Model Details

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Details the fields within the V3.Interchange model, which links two runs for vehicle interchange. It includes 'feeder' (previous run) and 'distributor' (next run) information.

```json
{
  "feeder": "V3.InterchangeRun",
  "distributor": "V3.InterchangeRun"
}
```

--------------------------------

### V3.DisruptionsResponse Model

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure for a successful (200) response containing disruption information for all route types. It includes a list of disruptions and API status metadata.

```json
{
  "disruptions": {
    "general": [
      {
        "disruption_id": 0,
        "title": "string",
        "url": "string",
        "description": "string",
        "disruption_status": "string",
        "disruption_type": "string",
        "published_on": "2025-09-02T05:45:06.621Z",
        "last_updated": "2025-09-02T05:45:06.621Z",
        "from_date": "2025-09-02T05:45:06.621Z",
        "to_date": "2025-09-02T05:45:06.621Z",
        "routes": [
          {
            "route_type": 0,
            "route_id": 0,
            "route_name": "string",
            "route_number": "string",
            "route_gtfs_id": "string",
            "direction": {
              "route_direction_id": 0,
              "direction_id": 0,
              "direction_name": "string"
            }
          }
        ],
        "stops": [
          {
            "stop_id": 0,
            "stop_name": "string"
          }
        ],
        "colour": "string",
        "display_on_board": true,
        "display_status": true
      }
    ],
    "metro_train": [],
    "metro_tram": [],
    "metro_bus": [],
    "regional_train": [],
    "regional_coach": [],
    "regional_bus": [],
    "school_bus": [],
    "telebus": [],
    "night_bus": [],
    "ferry": [],
    "interstate_train": [],
    "skybus": [],
    "taxi": []
  },
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### V3.OutletResponse - Ticket Outlets

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Defines the structure for a successful response containing a list of ticket outlets. Includes outlet details like name, location, and business hours, along with API status.

```json
{
  "outlets": [
    {
      "outlet_slid_spid": "string",
      "outlet_name": "string",
      "outlet_business": "string",
      "outlet_latitude": 0,
      "outlet_longitude": 0,
      "outlet_suburb": "string",
      "outlet_postcode": 0,
      "outlet_business_hour_mon": "string",
      "outlet_business_hour_tue": "string",
      "outlet_business_hour_wed": "string",
      "outlet_business_hour_thur": "string",
      "outlet_business_hour_fri": "string",
      "outlet_business_hour_sat": "string",
      "outlet_business_hour_sun": "string",
      "outlet_notes": "string"
    }
  ],
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Error Response (Status 400, 403)

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

Handles error responses for invalid requests or access denied. The V3.ErrorResponse model includes an error message and API status information.

```json
{
  "message": "string",
  "status": {
    "version": "string",
    "health": 0
  }
}
```

--------------------------------

### Directions Response Model

Source: https://timetableapi.ptv.vic.gov.au/swagger/docs/v3/swagger/ui/index

The response model for the directions API, detailing the structure of the returned data, including an array of directions and API status.

```json
{
  "directions": [
    {
      "route_direction_description": "string",
      "direction_id": 0,
      "direction_name": "string",
      "route_id": 0,
      "route_type": 0
    }
  ],
  "status": {
    "version": "string",
    "health": 0
  }
}
```
Tokens:
Raw