TravelTime Docs logo
TravelTime API
ArcGIS plugin
QGIS plugin
Alteryx plugin
/v4/routes

Routesanchor icon

Calculate A to B routes and turn-by-turn directions.

Access URL: https://api.traveltimeapp.com/v4/routes

Supports two HTTP request types:

  • GET - for simple requests using basic parameters only
  • POST - for more complex requests using advanced parameters

GET Requestanchor icon

A GET request is the simplest way to calculate a route. A single route can be generated by specifying the query parameters in the URL.

Query parametersanchor icon

string

Mode of transport used.
Available options: walking, public_transport, driving, cycling.

Latitude of the start location.

Longitude of the start location.

Latitude of the end location.

Longitude of the end location.

date in extended ISO-8601 format | optional

If this is specified, the journey must depart from the origin no earlier than the specified time.

date in extended ISO-8601 format | optional

If this is specified, the journey must arrive at the destination no later than the specified time.

string

Used for authenticating the request. Visit our developer portal to access your credentials or generate new ones.

string

Used for authenticating the request. Visit our developer portal to access your credentials or generate new ones.

Query responseanchor icon

Successful requests will return an HTTP 200 response.

Response schema - application/json

array[object]

The results array which is sorted lexicographically by the id attribute.

Hide child attributes
Show child attributes

The properties array containing the route.

Show child attributes

Travel time in seconds.

Distance in meters.

Show child attributes

date in extended ISO-8601 format

2022-09-22T14:00:00+03:00 or 2022-09-22T14:00:00Z.

date in extended ISO-8601 format

Example 2022-09-22T14:00:00+03:00 or 2022-09-22T14:00:00Z.

Show child attributes

A sequential id, used to relate route parts with fare data.

Possible values: basic, start_end, road or public_transport.

car, parking, boarding, walk, bike, bike_parking, train, rail_national, rail_overground, rail_underground, rail_dlr, bus, cable_car, plane, ferry or coach.

Distance in meters.

Travel time in seconds.

Only available when type is start_end.

May be present on parts where type is road.

May be present on parts where type is road.

Only available when type is public_transport.

Only available when type is public_transport.

Only available when type is public_transport.

Local departure time. Only available when type is public_transport.

Local arrival time. Only available when type is public_transport.

Only available when type is public_transport.

array[string]

Array of unreachable locations. A location will be unreachable if either of the following is true:

  1. The required travel time is greater than 2 hours.
  2. The location is in an inaccessible location (e.g on a body of water, or in an extremely remote area).
  3. The location is more than 15 minutes walk from the nearest public transport stop/station (public transport mode only).

Exampleanchor icon

Example request

Example request

https://api.traveltimeapp.com/v4/routes?type=public_transport&origin_lat=51.41070&origin_lng=-0.15540&destination_lat=51.59974&destination_lng=-0.19531&arrival_time=2022-09-22T15:00:00Z&app_id=YOUR_APP_ID&api_key=YOUR_API_KEY

POST Requestanchor icon

A POST request should be used when needing to configure the advanced parameters not available in the GET request.

The access URL is the same as the GET request format, but the differences are:

  • Authentication is included in the request Headers
  • Parameters are included in the request Body

Access URL: https://api.traveltimeapp.com/v4/routes

Request Bodyanchor icon

array[object]

Define your locations to use later in departure_searches or arrival_searches

Hide child attributes

You will have to reference this id in your searches. It will also be used in the response body. Must be unique among all locations.

The coordinates of the locations.

Show child attributes

Latitude.

Longitude.

array[object]

Searches based on departure time. Leave departure location at no earlier than given time. This allows you to specify a single departure location and multiple arrival locations. You can define a maximum of 10 searches.

Hide child attributes

Used to identify each search in the results array. Must be unique among all searches.

The id of the location we should start the search from. Must reference an id from locations array.

The ids of locations we should find the routes to. Must reference ids from locations array.

date in extended ISO-8601 format

Leave departure location at no earlier than given time. In ISO 8601 format. For example:
2022-09-22T14:00:00Z (representing UTC)
2022-09-22T14:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

Properties to be returned about the locations. Possible values: travel_time, distance, fares, route.

Transportation mode and related parameters. The default parameters are sensible and it is usually enough to only specify the type.

Show child attributes

cycling, driving, driving+train (only in Great Britain), public_transport, walking, coach, bus, train, ferry, driving+ferry, cycling+ferry or cycling+public_transport (only in Netherlands).

Maximum time (in seconds) allowed for walking at the start and end of a public transport journey. i.e:

  • the maximum walking time from the origin to the first stop/station, and
  • the maximum walking time from the final stop/station to the destination

These limits are independent and not cumulative. They only apply to the first and last walking legs of the journey - all walking times between public transport legs are limited to 600s (10 minutes) each.

The default value is 900.

Cannot be higher than travel_time.

Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes.

Time in seconds needed to board public transportation vehicle.
Default is 0.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes.

Maximum time (in seconds) allowed for driving from the origin to the train station.
Default value is 1800.
Used only in driving+train transportation mode.

Maximum time (in seconds) allowed for cycling (including any ferry transfers) from from the origin to the first stop/station.
Default value is 900.
Used only in cycling+public_transport transportation mode.

Time in seconds required to park a car or a bicycle.
Default value is 300.
Used in driving+train and cycling+public_transport transportation modes.

Time in seconds required to board a ferry.
Default value is 0.
Used in public_transport, ferry, driving+ferry, cycling+ferry and cycling+public_transport transportation modes. For public_transport mode, pt_change_delay is used instead.

If set to true, the crossing of country borders is disabled. Only available with the driving transportation mode, and is enabled by default (false).

Upper limit for the number of changes between public transit legs in a journey.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes the max_changes parameter is ignored.

Show child attributes

Enable transit leg change limit?

Maximum number of changes between transit legs in a journey. Must be at least 0.

object | optional

When enabled, range adds a departure window to the departure time, and results are returned for any journeys that depart during this window.
In the results array, the properties of these multiple alternative results are sorted by travel_time in ascending order.
Disabled by default.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes range search parameters are ignored.

Show child attributes

Enable range search?

Maximum number of results to return. Limited to 5 results.

When enabled, range adds an arrival window to the arrival time, and results are returned for any journeys that arrive during this window.
In the results array, the properties of these multiple alternative results are sorted by travel_time in ascending order.
Disabled by default.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes the parameter is ignored.

array[object]

Searches based on arrival time. Arrive at destination location at no later than given time. This allows you to specify a single arrival location and multiple departure locations. You can define a maximum of 10 searches

Show child attributes

Used to identify each search in the results array. Must be unique among all searches.

The id of the location we should start the search from. Must reference an id from locations array.

The ids of locations we should find the routes to. Must reference ids from locations array.

date in extended ISO-8601 format

Be at arrival location at no later than given time. In ISO 8601 format. For example:
2022-09-22T14:00:00Z (representing UTC)
2022-09-22T14:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

Properties to be returned about the locations. Possible values: travel_time, distance, fares, route.

Transportation mode and related parameters. The default parameters are sensible and it is usually enough to only specify the type.

Show child attributes

cycling, driving, driving+train (only in Great Britain), public_transport, walking, coach, bus, train, ferry, driving+ferry, cycling+ferry or cycling+public_transport (only in Netherlands).

Maximum time (in seconds) allowed for walking at the start and end of a public transport journey. i.e:

  • the maximum walking time from the origin to the first stop/station, and
  • the maximum walking time from the final stop/station to the destination

These limits are independent and not cumulative. They only apply to the first and last walking legs of the journey - all walking times between public transport legs are limited to 600s (10 minutes) each.

The default value is 900.

Cannot be higher than travel_time.

Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes.

Time in seconds needed to board public transportation vehicle.
Default is 0.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes.

Maximum time (in seconds) allowed for driving from the origin to the train station.
Default value is 1800.
Used only in driving+train transportation mode.

Maximum time (in seconds) allowed for cycling (including any ferry transfers) from from the origin to the first stop/station.
Default value is 900.
Used only in cycling+public_transport transportation mode.

Time in seconds required to park a car or a bicycle.
Default value is 300.
Used in driving+train and cycling+public_transport transportation modes.

Time in seconds required to board a ferry.
Default value is 0.
Used in public_transport, ferry, driving+ferry, cycling+ferry and cycling+public_transport transportation modes. For public_transport mode, pt_change_delay is used instead.

If set to true, the crossing of country borders is disabled. Only available with the driving transportation mode, and is enabled by default (false).

Upper limit for the number of changes between public transit legs in a journey.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes the max_changes parameter is ignored.

Show child attributes

Enable transit leg change limit?

Maximum number of changes between transit legs in a journey. Must be at least 0.

object | optional

When enabled, range adds an arrival window to the arrival time, and results are returned for any journeys that arrive during this window.
In the results array, the properties of these multiple alternative results are sorted by travel_time in ascending order.
Disabled by default.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes range search parameters are ignored.

Show child attributes

Enable range search?

Maximum number of results to return. Limited to 5 results.

When enabled, range adds an arrival window to the arrival time, and results are returned for any journeys that arrive during this window.
In the results array, the properties of these multiple alternative results are sorted by travel_time in ascending order.
Disabled by default.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes the parameter is ignored.

Response Bodyanchor icon

array[object]

The results array which is sorted lexicographically by the id attribute.

Hide child attributes
Show child attributes

Properties array. May contain multiple elements if range was enabled, single element otherwise. Sorted by travel_time. Only the properties included in the request are returned.

Show child attributes

Travel time in seconds.

Distance in meters.

Show child attributes

date in extended ISO-8601 format

2022-09-22T14:00:00+03:00 or 2022-09-22T14:00:00Z.

date in extended ISO-8601 format

Example 2022-09-22T14:00:00+03:00 or 2022-09-22T14:00:00Z.

Show child attributes

A sequential id, used to relate route parts with fare data.

Possible values: basic, start_end, road or public_transport.

car, parking, boarding, walk, bike, bike_parking, train, rail_national, rail_overground, rail_underground, rail_dlr, bus, cable_car, plane, ferry or coach.

Distance in meters.

Travel time in seconds.

Only available when type is start_end.

May be present on parts where type is road.

May be present on parts where type is road.

Only available when type is public_transport.

Only available when type is public_transport.

Only available when type is public_transport.

Local departure time. Only available when type is public_transport.

Local arrival time. Only available when type is public_transport.

Only available when type is public_transport.

Show child attributes
Show child attributes

Mode covered by the ticket, can be: car, parking, boarding, walk, bike, bike_parking, train, rail_national, rail_overground, rail_underground, rail_dlr, bus, cable_car, plane, ferry or coach.

Id's of route parts that are covered by these tickets.

Show child attributes
Show child attributes

Possible values: single, week, month or year.

array[string]

Id's of locations for which we cannot find a route. This can happen if the point cannot be reached within 12 hours.

Limitationsanchor icon

Currently “departure_location_id.arrival_location_ids” and “arrival_searches.departure_location_ids” array sizes are limited to a maximum of 2 values.

You can use time-filter with route property to work around this limitation, but you will have to specify “travel_time”.

Examplesanchor icon

Requestanchor icon

Loading

Response Bodyanchor icon

Loading

Request When a Route Cannot Be Foundanchor icon

Loading

Response Bodyanchor icon

Loading

Example Request

Loading

Response Body

Loading