Skip to content

Standard Routing





The standard route endpoint gives turn-by-turn directions between one or more points that must be visited in order. It is highly configurable with costing models (called profiles by some vendors) for car, bicycle, pedestrian, and more. We give developers an immense amount of room to fine tune routes for any application.

Here's a sampling of the versatility we offer:

  • Vehicle attributes (weight, height, width, top speed, etc.)
  • Prefer or avoid highways, toll roads, and ferries
  • Number of passengers, for HOV lane usage
  • Hill avoidance for bicycles, motor scooters, and pedestrians
  • Support for guidance in over 25 languages


Example Code


Get started quickly with code samples using our official SDKs or cURL. Official SDKs include documentation of all request and response models, either as separate pages, or through docstrings and autocomplete in most IDEs. If you are building for another language or want to try out requests in a browser, refer to our interactive API reference.

import { RoutingApi, Configuration, RouteRequest } from '@stadiamaps/api';

// If you are writing for a backend application or can't use domain-based auth,
// then you'll need to add your API key like so:
// const config = new Configuration({ apiKey: "YOUR-API-KEY" });
// You can also use our EU endpoint to keep traffic within the EU using the basePath option:
// const config = new Configuration({ basePath: "" });
// const api = new RoutingApi(config);
const api = new RoutingApi();

const locationA = {
    "lon": -76.306572,
    "lat": 40.042072,
    "type": RoutingWaypointTypeEnum.Break
const locationB = {
    "lon": -76.781559,
    "lat": 39.992115,
    "type": RoutingWaypointTypeEnum.Break
const req: RouteRequest = {
    locations: [
    costing: "auto",
    costingOptions: {
        auto: {
            useHighways: 0.3,  // Take the scenic route ;)
    directionsOptions: {
        units: DistanceUnit.Mi
const res = await api.route({ routeRequest: req });
import os
import stadiamaps
from import ApiException

# You can also use our EU endpoint to keep traffic within the EU like so:
# configuration = stadiamaps.Configuration(host="")
configuration = stadiamaps.Configuration()

# Configure API key authentication (ex: via environment variable).
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

with stadiamaps.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stadiamaps.RoutingApi(api_client)

        location_a = {"lat": 40.042072, "lon": -76.306572}
        location_b = {"lat": 39.992115, "lon": -76.781559}
        req = stadiamaps.RouteRequest(
            costing_options=stadiamaps.CostingOptions(auto=stadiamaps.AutoCostingOptions(use_highways=0.3)),  # Take the scenic route ;)

        res = api_instance.route(req)
    except ApiException as e:
        # Add your error handling here
        print("Exception when calling the Stadia Maps API: %s\n" % e)
// Imports (at the top of your source file; we've used some wildcard imports for simplicity)
import com.stadiamaps.api.apis.*
import com.stadiamaps.api.auth.ApiKeyAuth
import com.stadiamaps.api.infrastructure.*
import com.stadiamaps.api.models.*

// Set your API key (from an environment variable in this case)
val apiKey = System.getenv("STADIA_API_KEY") ?: throw RuntimeException("API Key not set")

// Defining the host is optional and defaults to
// You can also use our EU endpoint to keep traffic within the EU like so:
// val client = ApiClient(baseUrl = "")
val client = ApiClient()
client.addAuthorization("ApiKeyAuth", ApiKeyAuth("query", "api_key", apiKey))

// Configure a service for the group of APIs we want to talk to
val service = client.createService(

// Set up the request. Note: if you're using Kotlin with coroutines, you can also await
// rather than executing synchronously when using suspend functions.
val locations = listOf(
    RoutingWaypoint(40.042072, -76.306572), RoutingWaypoint(39.992115, -76.781559)
val costingOptions = CostingOptions(auto = AutoCostingOptions(useHighways = 0.3))  // Take the scenic route ;)
val directionsOptions = DirectionsOptions(units = DistanceUnit.mi, language = ValhallaLanguages.enMinusGB)
val req = RouteRequest(
    id = "route",
    locations = locations,
    costing =,
    costingOptions = costingOptions,
    directionsOptions = directionsOptions
val res = service.route(req).execute()

if (res.isSuccessful) {
    println("Found result: ${res.body()}")
} else {
    println("Request failed with error code ${res.code()}")
import StadiaMaps

// This setup code can go anywhere before you actually make an API call (typically in your app init)
func setupStadiaMapsAPI() {
    // Set your API key
    StadiaMapsAPI.customHeaders = ["Authorization": "Stadia-Auth YOUR-API-KEY"]
    // Optionally use our EU endpoint to keep traffic within the EU
    // StadiaMapsAPI.basePath = ""

// This function demonstrates how to call the Stadia Maps API.
// If you have not yet adopted async/await in your Swift codebase, you can use the Task API
// to call async functions in a non-async context:
func myFunction() async throws {
    let req = RouteRequest(id: "route",
                           locations: [
                               RoutingWaypoint(lat: 40.042072, lon: -76.306572),
                               RoutingWaypoint(lat: 39.992115, lon: -76.781559),
                           costing: .auto,
                           costingOptions: CostingOptions(auto: AutoCostingOptions(useTolls: 0.3)),  // Take the scenic route :)
                           directionsOptions: DirectionsOptions(units: .mi))
    let res = try await RoutingAPI.route(routeRequest: req)

    // Do something with the response...
curl -X POST -H "Content-Type: application/json" -d '{
    "locations": [
            "lon": -76.306572,
            "lat": 40.042072,
            "type": "break"
            "lon": -76.781559,
            "lat": 39.992115,
            "type": "break"
    "costing": "auto",
    "costing_options": {
        "auto": {
            "use_highways": 0.3
    "directions_options": {
        "units": "miles"
}' ""

Complementary APIs

The routing API deals in terms of geographic locations. In the case that you are dealing with human-readable addresses, you can use our forward geocoding and structured geocoding APIs to convert to latitude and longitude.

If you are building a turn-by-turn navigation application, you may find the nearest roads and trace attributes APIs useful for getting road attributes like tagged speed limits.

Finally, for fitness applications, you can augment routes with an elevation profile using our elevation API.

Next Steps