{
"openapi": "3.0.0",
"servers": [
{
"url": "https://router.api.gov.bc.ca/",
"description": "Production"
},
{
"url": "https://routertst.api.gov.bc.ca/",
"description": "Test"
},
{
"url": "https://router-dev.api.gov.bc.ca/",
"description": "Delivery"
}
],
"info": {
"title": "BC Route Planner REST API",
"description": "Finds shortest/fastest route between a start point and one or more stop points on British Columbia's public road network. The BC Route planner [webpage](https://www2.gov.bc.ca/gov/content?id=9D99E684CCD042CD88FADC51E079B4B5) provides additional information. Here are some geocoded addresses to play with:
18 Douglas St,Victoria -123.36962,48.40892
1002 Johnson St, Victoria -123.355745,48.426206
543 Johnson St, Victoria, BC -123.36907,48.42770
14 Centennial Sq, Victoria, BC -123.36564,48.42863
1105 Royal Ave,New Westminster -122.92009,49.20063
808 Jackson Cres, New Westminster -122.90762,49.22558
10810 McDonald Rd, Chilliwack -121.93808,49.19859
3950 June Springs Rd, Kelowna -119.40751,49.83960
1201 Riondel Rd, Kootenay Bay -116.85402,49.74448
1201 Riondel Rd, Kootenay Bay -116.832759,49.730500 (parcelPoint)
2499 Walbran Pl, Courtenay -124.97295,49.71518
2013 Smoke Bluff Rd, Squamish -123.13946,49.70401
235 Kelvin Grove Way, Lions Bay -123.23524,49.45035
Please see our data collection notice. \n\nPlease note that you may experience issues when submitting requests to the delivery or test environment if using this [OpenAPI specification](https://github.com/bcgov/api-specs) in other API console viewers. \n\n[API keys](https://api.gov.bc.ca/devportal/api-directory/740) are unique and can be acquired with a GitHub or IDIR account. \n\n",
"version": "2.0.0",
"license": {
"name": "Copyright Province of British Columbia - Access only",
"url": "https://www2.gov.bc.ca/gov/content?id=1AAACC9C65754E4D89A118B875E0FBDA"
},
"termsOfService": "http://www2.gov.bc.ca/gov/content?id=D1EE0A405E584363B205CD4353E02C88",
"contact": {
"name": "Contact DataBC",
"url": "https://dpdd.atlassian.net/servicedesk/customer/portal/1/group/7/"
}
},
"externalDocs": {
"description": "Developer Guide",
"url": "https://github.com/bcgov/ols-router/blob/gh-pages/router-developer-guide.md"
},
"tags": [
{
"name": "directions"
},
{
"name": "distance"
},
{
"name": "route"
}
],
"security": [
{
"apikey": []
}
],
"paths": {
"/distance.{outputFormat}": {
"get": {
"summary": "Get distance and travel time between two geographic points",
"description": "Represents the distance and time of the shortest or fastest path between given start and end points.",
"tags": [
"distance"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Distance and time of the shortest or fastest route"
}
}
},
"post": {
"summary": "Get distance and travel time between two geographic points",
"description": "Represents the distance and time of the shortest or fastest path between given start and end points.",
"tags": [
"distance"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Distance and time of the shortest or fastest route"
}
}
}
},
"/distance/betweenPairs.{outputFormat}": {
"get": {
"summary": "Get distance and travel time between each pair of geographic points",
"description": "Represents the distance and time of the shortest or fastest paths between all pairs of fromPoints and toPoints. The number of fromPoints times the number of toPoints should not exceed 100 or the request will time out.",
"tags": [
"distance"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "fromPoints",
"in": "query",
"description": "A comma-separated list of origin points. See fromPoints",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "toPoints",
"in": "query",
"description": "A comma-separated list of destination points. See toPoints",
"required": true,
"schema": {
"type": "string"
},
"example": "-124.972951,49.715181,-123.139464,49.704015"
},
{
"name": "maxPairs",
"in": "query",
"description": "The maximum number of pairs to return for each toPoint. Pairs are ordered by distance/time from fromPoint. For example, given 1 fromPoint, and 10 toPoints, and maxPairs=1 , return the nearest toPoint to the fromPoint. Given 3 fromPoints and 10 toPoints, maxPairs=3 means return the 3 nearest toPoints to each fromPoint.",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "A list of routes and their route distances/times."
}
}
},
"post": {
"summary": "Get distance and travel time between each pair of geographic points",
"description": "Represents the distance and time of the shortest or fastest paths between all pairs of fromPoints and toPoints. The number of fromPoints times the number of toPoints should not exceed 100 or the request will time out.",
"tags": [
"distance"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "fromPoints",
"in": "query",
"description": "A comma-separated list of origin points. See fromPoints",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "toPoints",
"in": "query",
"description": "A comma-separated list of destination points. See toPoints",
"required": true,
"schema": {
"type": "string"
},
"example": "-124.972951,49.715181,-123.139464,49.704015"
},
{
"name": "maxPairs",
"in": "query",
"description": "The maximum number of pairs to return for each toPoint. Pairs are ordered by distance/time from fromPoint. For example, given 1 fromPoint, and 10 toPoints, and maxPairs=1 , return the nearest toPoint to the fromPoint. Given 3 fromPoints and 10 toPoints, maxPairs=3 means return the 3 nearest toPoints to each fromPoint.",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "A list of routes and their route distances/times."
}
}
}
},
"/route.{outputFormat}": {
"get": {
"summary": "Get the path, distance and travel time between a series of geographic points",
"description": "Represents the geometry, distance, and time of the shortest or fastest path between given start and end points.",
"tags": [
"route"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start/end point.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled. (e.g., sc,tf,ev,td).
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Geometry, distance, and time of the shortest or fastest route"
}
}
},
"post": {
"summary": "Get the path, distance and travel time between a series of geographic points",
"description": "Represents the geometry, distance, and time of the shortest or fastest path between given start and end points.",
"tags": [
"route"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start/end point.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Geometry, distance, and time of the shortest or fastest route"
}
}
}
},
"/directions.{outputFormat}": {
"get": {
"summary": "Get the directions, path, distance and travel time between a series of geographic points",
"description": "Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points",
"tags": [
"directions"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start/end point.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "simplifyDirections",
"in": "query",
"description": "Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "simplifyThreshold",
"in": "query",
"description": "The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.
If simplifyDirections is false, this value will be ignored.",
"required": false,
"schema": {
"type": "integer",
"default": 250
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "turn-by-turn directions, geometry, distance, and time of the shortest or fastest route"
}
}
},
"post": {
"summary": "Get the directions, path, distance and travel time between a series of geographic points",
"description": "Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points",
"tags": [
"directions"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start/end point.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "simplifyDirections",
"in": "query",
"description": "Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "simplifyThreshold",
"in": "query",
"description": "The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.
If simplifyDirections is false, this value will be ignored.",
"required": false,
"schema": {
"type": "integer",
"default": 250
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "turn-by-turn directions, geometry, distance, and time of the shortest or fastest route"
}
}
}
},
"/optimalRoute.{outputFormat}": {
"get": {
"summary": "Get the optimal path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time.",
"description": "Represents the geometry, distance, and time of the shortest or fastest path between a start point and a series of end points which are reordered to minimize distance or time",
"tags": [
"route"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time"
}
}
},
"post": {
"summary": "Get the path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time.",
"description": "Represents the geometry, distance, and time of the shortest or fastest path between a start point and a series of end points which are reordered to minimize total distance or time.",
"tags": [
"route"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time."
}
}
}
},
"/optimalDirections.{outputFormat}": {
"get": {
"summary": "Get the directions, optimal path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time.",
"description": "Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between a start point and a series of end points which are reordered to minimize distance/time",
"tags": [
"directions"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "simplifyDirections",
"in": "query",
"description": "Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "simplifyThreshold",
"in": "query",
"description": "The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.
If simplifyDirections is false, this value will be ignored.",
"required": false,
"schema": {
"type": "integer",
"default": 250
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "turn-by-turn directions, geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time."
}
}
},
"post": {
"summary": "Get the directions, optimal path, distance and travel time between a start point and one or more end points which are reordered to minimize total distance or time.",
"description": "Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between a start point and one or more end points which are reordered to minimize distance or time.",
"tags": [
"directions"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "simplifyDirections",
"in": "query",
"description": "Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "simplifyThreshold",
"in": "query",
"description": "The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.
If simplifyDirections is false, this value will be ignored.",
"required": false,
"schema": {
"type": "integer",
"default": 250
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "turn-by-turn directions, geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time."
}
}
}
},
"/truck/distance.{outputFormat}": {
"get": {
"summary": "Get distance and travel time between two geographic points for a commercial vehicle",
"description": "Represents the distance and time of the shortest or fastest path between given start and end points.",
"tags": [
"distance"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled. (e.g., sc,tf,ev,td).
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Distance and time of the shortest or fastest route"
}
}
},
"post": {
"summary": "Get distance and travel time between two geographic points",
"description": "Represents the distance and time of the shortest or fastest path between given start and end points.",
"tags": [
"distance"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Distance and time of the shortest or fastest route"
}
}
}
},
"/truck/route.{outputFormat}": {
"get": {
"summary": "Get the path, distance and travel time between a series of geographic points for a commercial vehicle",
"description": "Represents the geometry, distance, and time of the shortest or fastest path between given start and end points for a commercial vehicle.",
"tags": [
"route"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start/end point.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "partition",
"in": "query",
"description": "A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used.
Partition values:
isTruckRoute – Distinguish between truck route sections and non-truck route sections
isFerry – Distinguish between ferry sections and non-ferry sections
locality – Include the locality name for the route partition
ownership - Include road ownership",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled. (e.g., sc,tf,ev,td).
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "listRestrictions",
"in": "query",
"description": "Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Geometry, distance, and time of the shortest or fastest route"
}
}
},
"post": {
"summary": "Get the path, distance and travel time between a series of geographic points",
"description": "Represents the geometry, distance, and time of the shortest or fastest path between given start and end points.",
"tags": [
"route"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start/end point.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "partition",
"in": "query",
"description": "A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used.
Partition values:
isTruckRoute – Distinguish between truck route sections and non-truck route sections
isFerry – Distinguish between ferry sections and non-ferry sections
locality – Include the locality name for the route partition
ownership - Include road ownership",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "listRestrictions",
"in": "query",
"description": "Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Geometry, distance, and time of the shortest or fastest route"
}
}
}
},
"/truck/directions.{outputFormat}": {
"get": {
"summary": "Get the directions, path, distance and travel time between a series of geographic points for a commercial vehicle",
"description": "Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points for a commercial vehicle",
"tags": [
"directions"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start/end point.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "partition",
"in": "query",
"description": "A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used.
Partition values:
isTruckRoute – Distinguish between truck route sections and non-truck route sections
isFerry – Distinguish between ferry sections and non-ferry sections
locality – Include the locality name for the route partition
ownership - Include road ownership",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "simplifyDirections",
"in": "query",
"description": "Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "simplifyThreshold",
"in": "query",
"description": "The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.
If simplifyDirections is false, this value will be ignored.",
"required": false,
"schema": {
"type": "integer",
"default": 250
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "listRestrictions",
"in": "query",
"description": "Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "turn-by-turn directions, geometry, distance, and time of the shortest or fastest route"
}
}
},
"post": {
"summary": "Get the directions, path, distance and travel time between a series of geographic points",
"description": "Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points",
"tags": [
"directions"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start/end point.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "partition",
"in": "query",
"description": "A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used.
Partition values:
isTruckRoute – Distinguish between truck route sections and non-truck route sections
isFerry – Distinguish between ferry sections and non-ferry sections
locality – Include the locality name for the route partition
ownership - Include road ownership",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "simplifyDirections",
"in": "query",
"description": "Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "simplifyThreshold",
"in": "query",
"description": "The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.
If simplifyDirections is false, this value will be ignored.",
"required": false,
"schema": {
"type": "integer",
"default": 250
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "listRestrictions",
"in": "query",
"description": "Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "turn-by-turn directions, geometry, distance, and time of the shortest or fastest route"
}
}
}
},
"/truck/optimalRoute.{outputFormat}": {
"get": {
"summary": "Get the optimal path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time for a commercial vehicle",
"description": "Represents the geometry, distance, and time of the shortest or fastest path between a start point and a series of end points which are reordered to minimize distance or time for a commercial vehicle.",
"tags": [
"route"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "partition",
"in": "query",
"description": "A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used.
Partition values:
isTruckRoute – Distinguish between truck route sections and non-truck route sections
isFerry – Distinguish between ferry sections and non-ferry sections
locality – Include the locality name for the route partition
ownership - Include road ownership",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "listRestrictions",
"in": "query",
"description": "Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time"
}
}
},
"post": {
"summary": "Get the path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time.",
"description": "Represents the geometry, distance, and time of the shortest or fastest path between a start point and a series of end points which are reordered to minimize total distance or time.",
"tags": [
"route"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "partition",
"in": "query",
"description": "A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used.
Partition values:
isTruckRoute – Distinguish between truck route sections and non-truck route sections
isFerry – Distinguish between ferry sections and non-ferry sections
locality – Include the locality name for the route partition
ownership - Include road ownership",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "listRestrictions",
"in": "query",
"description": "Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "Geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time."
}
}
}
},
"/truck/optimalDirections.{outputFormat}": {
"get": {
"summary": "Get the directions, optimal path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time for a commercial vehicle",
"description": "Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between a start point and a series of end points which are reordered to minimize distance/time for a commercial vehicle.",
"tags": [
"directions"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "partition",
"in": "query",
"description": "A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used.
Partition values:
isTruckRoute – Distinguish between truck route sections and non-truck route sections
isFerry – Distinguish between ferry sections and non-ferry sections
locality – Include the locality name for the route partition
ownership - Include road ownership",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "simplifyDirections",
"in": "query",
"description": "Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "simplifyThreshold",
"in": "query",
"description": "The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.
If simplifyDirections is false, this value will be ignored.",
"required": false,
"schema": {
"type": "integer",
"default": 250
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "listRestrictions",
"in": "query",
"description": "Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "turn-by-turn directions, geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time."
}
}
},
"post": {
"summary": "Get the directions, optimal path, distance and travel time between a start point and one or more end points which are reordered to minimize total distance or time.",
"description": "Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between a start point and one or more end points which are reordered to minimize distance or time.",
"tags": [
"directions"
],
"parameters": [
{
"name": "outputFormat",
"in": "path",
"description": "Format of representation",
"required": true,
"schema": {
"type": "string",
"enum": [
"json",
"kml",
"html"
],
"default": "json"
},
"example": "json"
},
{
"name": "points",
"in": "query",
"description": "A list of any number of route points in start to end order. See points",
"required": true,
"schema": {
"type": "string"
},
"example": "-123.70794,48.77869,-123.53785,48.38200"
},
{
"name": "outputSRS",
"in": "query",
"description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS",
"required": false,
"schema": {
"type": "integer",
"enum": [
4326,
4269,
3005,
26907,
26908,
26909,
26910,
26911
],
"default": 4326
}
},
{
"name": "criteria",
"in": "query",
"description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.",
"required": false,
"schema": {
"type": "string",
"enum": [
"shortest",
"fastest"
],
"default": "fastest"
}
},
{
"name": "distanceUnit",
"in": "query",
"description": "distance unit of measure (e.g., km, mi). Default is km.",
"required": false,
"schema": {
"type": "string",
"enum": [
"km",
"mi"
],
"default": "km"
}
},
{
"name": "roundTrip",
"in": "query",
"description": "If true, route ends at start point. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "correctSide",
"in": "query",
"description": "If true, route starts and ends on same side of road as start and end points.Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "departure",
"in": "query",
"description": "departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00);
Ignored if time-dependency modules are disabled",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "truckRouteMultiplier",
"in": "query",
"description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.",
"required": false,
"schema": {
"type": "integer",
"default": 9
}
},
{
"name": "height",
"in": "query",
"description": "The height of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "width",
"in": "query",
"description": "The width of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "length",
"in": "query",
"description": "The length of the truck in metres (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "weight",
"in": "query",
"description": "The weight of the truck in kilograms (**only suitable for demos**).",
"required": false,
"schema": {
"type": "number",
"default": null
}
},
{
"name": "partition",
"in": "query",
"description": "A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used.
Partition values:
isTruckRoute – Distinguish between truck route sections and non-truck route sections
isFerry – Distinguish between ferry sections and non-ferry sections
locality – Include the locality name for the route partition
ownership - Include road ownership",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "enable",
"in": "query",
"description": "A comma-separated list of modules to enable. Enable takes precedence over disable.
When the enable parameter is used, unlisted values will be disabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "gdf,ldf,tr,xc,tc"
}
},
{
"name": "disable",
"in": "query",
"description": "A comma-separated list of modules to disable. Enable takes precedence over disable.
When the disable parameter is used, unlisted values will be enabled.
Module names include:
sc – ferry schedules; disabled by default and only suitable for demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default",
"required": false,
"schema": {
"type": "string",
"default": "td,ev,sc,tf,tl"
}
},
{
"name": "simplifyDirections",
"in": "query",
"description": "Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "simplifyThreshold",
"in": "query",
"description": "The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.
If simplifyDirections is false, this value will be ignored.",
"required": false,
"schema": {
"type": "integer",
"default": 250
}
},
{
"name": "snapDistance",
"in": "query",
"description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.",
"required": false,
"schema": {
"type": "integer",
"default": 1000
}
},
{
"name": "listRestrictions",
"in": "query",
"description": "Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictionSource",
"in": "query",
"description": "Specify the source of road restrictions. Options include:
ITN - Integrated Transportation Network.
RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**).
Default is ITN.",
"required": false,
"schema": {
"type": "string",
"default": "ITN"
}
},
{
"name": "excludeRestrictions",
"in": "query",
"description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "restrictionValues",
"in": "query",
"description": "A comma-separated list of restriction types and their values (**only suitable for demos**).
If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used.
VERTICAL - Height in metres (e.g., VERTICAL:4.5).
HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)
LENGTH - Length in metres (e.g., LENGTH:8.2)
WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)
WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)
WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)
WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)
NCV - No Commercial Vehicles (e.g., NCV:1)
NSI - No Self Issue (**not implemented**)",
"required": false,
"schema": {
"type": "string",
"default": null
}
},
{
"name": "routeDescription",
"in": "query",
"description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)",
"required": false,
"schema": {
"type": "string",
"default": "Routing results"
}
}
],
"responses": {
"200": {
"description": "turn-by-turn directions, geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time."
}
}
}
}
},
"components": {
"schemas": {},
"securitySchemes": {
"apikey": {
"type": "apiKey",
"in": "header",
"name": "apikey"
}
}
}
}