npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@datafire/gov_bc_ca_router

v6.0.0

Published

DataFire integration for BC Route Planner REST API

Downloads

29

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/gov_bc_ca_router

Client library for BC Route Planner REST API

Installation and Usage

npm install --save @datafire/gov_bc_ca_router
let gov_bc_ca_router = require('@datafire/gov_bc_ca_router').create({
  apikey: ""
});

.then(data => {
  console.log(data);
});

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 provides additional information. Here are some geocoded addresses to play with:18 Douglas St,Victoria -123.36962,48.408921002 Johnson St, Victoria -123.355745,48.426206543 Johnson St, Victoria, BC -123.36907,48.42770 14 Centennial Sq, Victoria, BC -123.36564,48.428631105 Royal Ave,New Westminster -122.92009,49.20063808 Jackson Cres, New Westminster -122.90762,49.2255810810 McDonald Rd, Chilliwack -121.93808,49.198593950 June Springs Rd, Kelowna -119.40751,49.839601201 Riondel Rd, Kootenay Bay -116.85402,49.744481201 Riondel Rd, Kootenay Bay -116.832759,49.730500 (parcelPoint)2499 Walbran Pl, Courtenay -124.97295,49.715182013 Smoke Bluff Rd, Squamish -123.13946,49.70401235 Kelvin Grove Way, Lions Bay -123.23524,49.45035 Please see our data collection notice.

Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.

Developer API keys are unique and can be acquired with a GitHub account. Production government applications may use organization API keys acquired by contacting DataBC.

Actions

directions.outputFormat.get

Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points

gov_bc_ca_router.directions.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start/end point.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

directions.outputFormat.post

Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points

gov_bc_ca_router.directions.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start/end point.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

distance.outputFormat.get

Represents the distance and time of the shortest or fastest path between given start and end points.

gov_bc_ca_router.distance.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

distance.outputFormat.post

Represents the distance and time of the shortest or fastest path between given start and end points.

gov_bc_ca_router.distance.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

distance.betweenPairs.outputFormat.get

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.

gov_bc_ca_router.distance.betweenPairs.outputFormat.get({
  "outputFormat": "",
  "fromPoints": "",
  "toPoints": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, html): Format of representation
    • fromPoints required string: A comma-separated list of origin points. See fromPoints
    • toPoints required string: A comma-separated list of destination points. See toPoints
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)
    • maxPairs integer: 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.

Output

Output schema unknown

distance.betweenPairs.outputFormat.post

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.

gov_bc_ca_router.distance.betweenPairs.outputFormat.post({
  "outputFormat": "",
  "fromPoints": "",
  "toPoints": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, html): Format of representation
    • fromPoints required string: A comma-separated list of origin points. See fromPoints
    • toPoints required string: A comma-separated list of destination points. See toPoints
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)
    • maxPairs integer: 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.

Output

Output schema unknown

optimalDirections.outputFormat.get

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

gov_bc_ca_router.optimalDirections.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

optimalDirections.outputFormat.post

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.

gov_bc_ca_router.optimalDirections.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

optimalRoute.outputFormat.get

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

gov_bc_ca_router.optimalRoute.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

optimalRoute.outputFormat.post

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.

gov_bc_ca_router.optimalRoute.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

route.outputFormat.get

Represents the geometry, distance, and time of the shortest or fastest path between given start and end points.

gov_bc_ca_router.route.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start/end point.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td). Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

route.outputFormat.post

Represents the geometry, distance, and time of the shortest or fastest path between given start and end points.

gov_bc_ca_router.route.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start/end point.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.directions.outputFormat.get

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

gov_bc_ca_router.truck.directions.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start/end point.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.directions.outputFormat.post

Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points

gov_bc_ca_router.truck.directions.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start/end point.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.distance.outputFormat.get

Represents the distance and time of the shortest or fastest path between given start and end points.

gov_bc_ca_router.truck.distance.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.distance.outputFormat.post

Represents the distance and time of the shortest or fastest path between given start and end points.

gov_bc_ca_router.truck.distance.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.distance.betweenPairs.outputFormat.get

Represents the distance and time of the shortest or fastest paths between all pairs of fromPoints and toPoints for a commercial vehicle. The number of fromPoints times the number of toPoints should not exceed 100 or the request will time out.

gov_bc_ca_router.truck.distance.betweenPairs.outputFormat.get({
  "outputFormat": "",
  "fromPoints": "",
  "toPoints": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, html): Format of representation
    • fromPoints required string: A comma-separated list of origin points. See fromPoints
    • toPoints required string: A comma-separated list of destination points. See toPoints
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)
    • maxPairs integer: 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.

Output

Output schema unknown

truck.distance.betweenPairs.outputFormat.post

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.

gov_bc_ca_router.truck.distance.betweenPairs.outputFormat.post({
  "outputFormat": "",
  "fromPoints": "",
  "toPoints": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, html): Format of representation
    • fromPoints required string: A comma-separated list of origin points. See fromPoints
    • toPoints required string: A comma-separated list of destination points. See toPoints
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)
    • maxPairs integer: 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.

Output

Output schema unknown

truck.optimalDirections.outputFormat.get

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.

gov_bc_ca_router.truck.optimalDirections.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.optimalDirections.outputFormat.post

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.

gov_bc_ca_router.truck.optimalDirections.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.optimalRoute.outputFormat.get

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.

gov_bc_ca_router.truck.optimalRoute.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.optimalRoute.outputFormat.post

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.

gov_bc_ca_router.truck.optimalRoute.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start and end points.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.route.outputFormat.get

Represents the geometry, distance, and time of the shortest or fastest path between given start and end points for a commercial vehicle.

gov_bc_ca_router.truck.route.outputFormat.get({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start/end point.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td). Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

truck.route.outputFormat.post

Represents the geometry, distance, and time of the shortest or fastest path between given start and end points.

gov_bc_ca_router.truck.route.outputFormat.post({
  "outputFormat": "",
  "points": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, kml, html): Format of representation
    • points required string: A list of any number of route points in start to end order. See points
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • criteria string (values: shortest, fastest): Routing criteria to optimize (e.g., shortest, fastest). Default is shortest.
    • distanceUnit string (values: km, mi): distance unit of measure (e.g., km, mi). Default is km.
    • roundTrip boolean: If true, route ends at start point. Default is false.
    • departure string: 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
    • correctSide boolean: If true, route starts and ends on same side of road as start/end point.Default is false.
    • disable string: A comma-separated list of time-related modules to disable (e.g., sc,tf,ev,td).Module names include: sc – ferry schedules; disabled by default; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabling this disables sc, tf, and ev modulestr – turn restrictions; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns)
    • routeDescription string: Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)

Output

Output schema unknown

Definitions

This integration has no definitions