Bc

BC Route Planner REST API

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…

Government & public#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.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 .

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.

API keys are unique and can be acquired with a GitHub or IDIR account.

Endpoints 24

directions

  • GETGet the directions, path, distance and travel time between a series of geographic points/directions.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points
  • POSTGet the directions, path, distance and travel time between a series of geographic points/directions.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points
  • GETGet 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./optimalDirections.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…
  • POSTGet 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./optimalDirections.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…
  • GETGet the directions, path, distance and travel time between a series of geographic points for a commercial vehicle/truck/directions.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&partition=&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…
  • POSTGet the directions, path, distance and travel time between a series of geographic points/truck/directions.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&partition=&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points
  • GETGet 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/truck/optimalDirections.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&partition=&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…
  • POSTGet 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./truck/optimalDirections.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&partition=&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…

distance

  • GETGet distance and travel time between two geographic points/distance.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the distance and time of the shortest or fastest path between given start and end points.
  • POSTGet distance and travel time between two geographic points/distance.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the distance and time of the shortest or fastest path between given start and end points.
  • GETGet distance and travel time between each pair of geographic points/distance/betweenPairs.:outputFormat?fromPoints=-123.70794,48.77869,-123.53785,48.38200&toPoints=-124.972951,49.715181,-123.139464,49.704015&outputSRS=4326&criteria=shortest&distanceUnit=km&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing results&maxPairs=0Represents 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…
  • POSTGet distance and travel time between each pair of geographic points/distance/betweenPairs.:outputFormat?fromPoints=-123.70794,48.77869,-123.53785,48.38200&toPoints=-124.972951,49.715181,-123.139464,49.704015&outputSRS=4326&criteria=shortest&distanceUnit=km&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing results&maxPairs=0Represents 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…
  • GETGet distance and travel time between two geographic points for a commercial vehicle/truck/distance.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the distance and time of the shortest or fastest path between given start and end points.
  • POSTGet distance and travel time between two geographic points/truck/distance.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the distance and time of the shortest or fastest path between given start and end points.
  • GETGet distance and travel time between each pair of geographic points for a commercial vehicle/truck/distance/betweenPairs.:outputFormat?fromPoints=-123.70794,48.77869,-123.53785,48.38200&toPoints=-124.972951,49.715181,-123.139464,49.704015&outputSRS=4326&criteria=shortest&distanceUnit=km&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing results&maxPairs=0Represents the distance and time of the shortest or fastest paths between all pairs of fromPoints and toPoints for a commercial vehicle. The number of…
  • POSTGet distance and travel time between each pair of geographic points/truck/distance/betweenPairs.:outputFormat?fromPoints=-123.70794,48.77869,-123.53785,48.38200&toPoints=-124.972951,49.715181,-123.139464,49.704015&outputSRS=4326&criteria=shortest&distanceUnit=km&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing results&maxPairs=0Represents 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…

route

  • GETGet 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./optimalRoute.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…
  • POSTGet 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./optimalRoute.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…
  • GETGet the path, distance and travel time between a series of geographic points/route.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the geometry, distance, and time of the shortest or fastest path between given start and end points.
  • POSTGet the path, distance and travel time between a series of geographic points/route.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the geometry, distance, and time of the shortest or fastest path between given start and end points.
  • GETGet 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/truck/optimalRoute.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&partition=&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…
  • POSTGet 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./truck/optimalRoute.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&partition=&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents 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…
  • GETGet the path, distance and travel time between a series of geographic points for a commercial vehicle/truck/route.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&partition=&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the geometry, distance, and time of the shortest or fastest path between given start and end points for a commercial vehicle.
  • POSTGet the path, distance and travel time between a series of geographic points/truck/route.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&truckRouteMultiplier=9&partition=&disable=sc,tf,ev,td&routeDescription=Routing resultsRepresents the geometry, distance, and time of the shortest or fastest path between given start and end points.

API details

Base URL
https://router.api.gov.bc.ca
https://routertst.api.gov.bc.ca
https://router-dev.api.gov.bc.ca
Authentication
An API key in the apikey header
Operations
24 operations on 12 pathsGET 12POST 12
Main resources
directions 8distance 8route 8
Description format
OpenAPI 3.0.0, API version 2.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the BC Route Planner REST API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BC Route Planner REST API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the apikey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get the directions, path, distance and travel time between a series of geographic points” (GET /directions.:outputFormat?points=-123.70794,48.77869,-123.53785,48.38200&outputSRS=4326&criteria=shortest&distanceUnit=km&roundTrip=false&departure=2024-01-01T00:00:00Z&correctSide=false&disable=sc,tf,ev,td&routeDescription=Routing results), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BC Route Planner REST API?

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… It is listed under Government & public and has 24 endpoints.

Who publishes the BC Route Planner REST API?

It is listed from Bc's public API description (an OpenAPI document), not published by Bc on Swastik Codes. Anyone who controls gov.bc.ca can claim the profile by adding a DNS TXT record.

What is the base URL of the BC Route Planner REST API?

Its description lists 3 base URLs: https://router.api.gov.bc.ca, https://routertst.api.gov.bc.ca, https://router-dev.api.gov.bc.ca. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the BC Route Planner REST API?

With an API key in the apikey header.

How many endpoints does the BC Route Planner REST API have?

24 operations on 12 paths (12 GET, 12 POST). The largest groups are directions, distance, route.

Is forking the BC Route Planner REST API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.