Gov Bc Ca BC Route Planner REST API

Name: BC Route Planner REST API
Brand: BC Route Planner REST API
Availability: InStock

✓ Official Vendor SpecMaps GeolocationRouting DirectionsapiKey22 Endpoints

Install Jentic One Beta

Connect the BC Route Planner REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the BC Route Planner REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with BC Route Planner REST API.

Calculate distance and travel time between two BC coordinates with /distance

Compute distance and travel time across all pairs in a coordinate list via /distance/betweenPairs

Generate the shortest or fastest route through an ordered series of stops

GET STARTED

Start building with BC Route Planner REST API

Explore with Jentic

View OpenAPI Document

For Agents

Compute distance, optimal routes, and turn-by-turn directions across British Columbia's road network, with a separate truck mode that respects commercial vehicle restrictions.

Use for: Calculate the fastest driving route between Victoria and Vancouver, Get turn-by-turn directions for a multi-stop delivery in BC, Find the optimal stop order for a 5-address service technician run, Compute distance and travel time between a list of coordinate pairs

Not supported: Does not handle geocoding, live traffic events, or routing outside British Columbia - use for BC road network routing only.

Use Cases

Patterns agents use BC Route Planner REST API for, with concrete tasks.

★ Government Field Service Routing

BC Government ministries dispatching field crews use the Route Planner to order a day of stops and produce turn-by-turn directions. POST /optimalDirections accepts a start point and a list of stops, reorders them to minimise total travel time, and returns the directions and geometry. The API is restricted to B.C. Government Ministries, so external commercial users will not be granted keys.

Call POST /optimalDirections.json with a start point and 6 stops, then return the reordered stop list and total drive time.

Commercial Truck Route Planning

The /truck/* endpoint family applies BC's commercial vehicle restrictions, including height, weight, and dangerous goods limits, when computing routes. Agents pass standard routing parameters plus truck attributes and receive a route that avoids restricted bridges and roads. This is the only mode that respects truck-specific limits - the passenger endpoints will return shorter routes that may be illegal for commercial vehicles.

Call POST /truck/route.json with truckHeight=4.0 and truckWeight=20000 to get a legal route between two BC depots.

Distance Matrix for Logistics Planning

Logistics planners building a delivery schedule need distance and travel time across every pair of stops. /distance/betweenPairs accepts a list of coordinates and returns the full pairwise matrix in a single call, avoiding the round-trip cost of calling /distance N-squared times. Output supports JSON for downstream optimisation and GeoJSON when geometry is required.

Call POST /distance/betweenPairs.json with 8 coordinate pairs and parse the returned matrix into a Python dict for vehicle routing.

Multi-Format Route Export

Each routing endpoint accepts an outputFormat path parameter (json, geojson, kml) so the same operation can drive a JSON-consuming agent, a Leaflet map, or a Google Earth export without a separate transformation step. Agents pick the format based on the downstream consumer at request time.

Call GET /route.kml with two BC coordinates and save the response as a .kml file for Google Earth visualisation.

Agent-Driven Route Lookup via Jentic

An AI agent assisting a BC Ministry user can use Jentic to discover the Route Planner, load the /optimalDirections schema, and execute the call without reading the BC API directory. Jentic stores the apikey in your Jentic One instance and injects it at execution time, so the agent never sees the raw secret.

Use the Jentic SDK to search 'plan an optimal multi-stop bc route', load /optimalDirections, and execute with a start point and four stops.

Key Endpoints

22 endpoints — the bc route planner is the british columbia government's routing engine for the province's public road network, computing shortest and fastest routes between a start point and one or more stops.

METHOD

PATH

DESCRIPTION

POST

/optimalDirections.{outputFormat}

Reorder stops and return optimal directions with geometry

POST

/route.{outputFormat}

Compute a route through an ordered list of stops

POST

/distance/betweenPairs.{outputFormat}

Pairwise distance and travel time matrix

POST

/truck/route.{outputFormat}

Truck-legal routing respecting commercial restrictions

POST

/truck/optimalRoute.{outputFormat}

Stop-reordered truck routing

GET

/distance.{outputFormat}

Distance and travel time between two points

POST

/optimalDirections.{outputFormat}

Reorder stops and return optimal directions with geometry

POST

/route.{outputFormat}

Compute a route through an ordered list of stops

POST

/distance/betweenPairs.{outputFormat}

Pairwise distance and travel time matrix

POST

/truck/route.{outputFormat}

Truck-legal routing respecting commercial restrictions

POST

/truck/optimalRoute.{outputFormat}

Stop-reordered truck routing

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your BC Route Planner apikey is stored once, encrypted, by your own Jentic One instance and injected as the apikey header at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'plan a truck route in british columbia', and Jentic returns the matching route operation with its parameter schema so the agent picks the right endpoint without reading 22 path definitions.

Time to first call

FAQs

Specific to using BC Route Planner REST API through Jentic.

What authentication does the BC Route Planner API use?

The API uses an apikey header (security scheme name 'apikey'). Keys are issued through the BC API directory at api.gov.bc.ca and are tied to a GitHub or IDIR account. Through Jentic, the apikey is stored encrypted in your Jentic One instance and injected on every request so the agent never handles the raw key.

Can I use the BC Route Planner if I am not a BC Government Ministry?

No. The spec explicitly states that the BC Route Planner is currently only available for use by B.C. Government Ministries. External developers can request a key through the BC API directory but should expect denial unless they have a ministry sponsor.

What are the rate limits for the BC Route Planner API?

The OpenAPI spec does not publish rate limits. Limits are enforced at the api.gov.bc.ca gateway and are tied to the issued apikey. Plan for conservative concurrency and cache /distance results for repeated coordinate pairs.

How do I get truck-legal routing through Jentic?

Search Jentic for 'plan a truck route in british columbia', then load /truck/route or /truck/directions. Pass truckHeight, truckWeight, and other truck attributes documented in the spec, and the engine will avoid restricted segments. Passenger endpoints under /route ignore these limits, so always use the /truck/* family for commercial vehicles.

What output formats does the BC Route Planner support?

Each routing endpoint takes an outputFormat path parameter - json, geojson, and kml are supported. Pick json for agent processing, geojson for web map rendering, and kml when the downstream consumer is Google Earth or another KML-aware tool.

Can I solve a travelling-salesman ordering with this API?

Yes. POST /optimalRoute and /optimalDirections accept a start point plus a list of stops and return the reordered sequence that minimises total travel time, along with the full route geometry and directions in one response.

Can I limit what my agent is allowed to do with the BC Route Planner API?

Yes. Because you self-host your own Jentic One instance, your rules decide which of the Route Planner's operations the agent may call and which credentials it may use. Since each request passes the origin, destination, and options in the body rather than a resource id in the path, you scope access at the operation level, allowing only what the agent needs such as planning a passenger route with /route or a truck-legal route with /truck/route. Any operation you have not included, like /distance/betweenPairs or /optimalDirections, stays out of the agent's reach.

Gov Bc Ca BC Route Planner REST API

Connect the BC Route Planner REST API to your agent

Capabilities

Start building with BC Route Planner REST API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs