Time/Distance Matrix¶

import { RoutingApi, Configuration, MatrixRequest } 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" }); (1)
// You can also use our EU endpoint to keep traffic within the EU using the basePath option:
// const config = new Configuration({ basePath: "https://api-eu.stadiamaps.com" });
// const api = new RoutingApi(config);
const api = new RoutingApi();

const req: MatrixRequest = {
    id: "matrix",
    sources: [
        {
            lat: 40.744014,
            lon: -73.990508
        }
    ],
    targets: [
        {
            lat: 40.744014,
            lon: -73.990508
        },
        {
            lat: 40.739735,
            lon: -73.979713
        },
        {
            lat: 40.752522,
            lon: -73.985015
        },
        {
            lat: 40.750117,
            lon: -73.983704
        },
        {
            lat: 40.750552,
            lon: -73.993519
        }
    ],
    costing: "pedestrian"
};
const res = await api.timeDistanceMatrix({ matrixRequest: req });

import os
import stadiamaps
from stadiamaps.rest import ApiException

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

# Configure API key authentication (ex: via environment variable). (1)
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)

    try:
        location_a = {"lat": 40.042072, "lon": -76.306572}
        location_b = {"lat": 39.992115, "lon": -76.781559}
        location_c = {"lat": 39.984519, "lon": -76.6956}
        req = stadiamaps.MatrixRequest(
            id="matrix",
            sources=[
                stadiamaps.MatrixWaypoint.from_dict(location_a),
            ],
            targets=[
                stadiamaps.MatrixWaypoint.from_dict(location_b),
                stadiamaps.MatrixWaypoint.from_dict(location_c),
            ],
            costing=stadiamaps.MatrixCostingModel.PEDESTRIAN,
        )

        res = api_instance.time_distance_matrix(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) (1)
val apiKey = System.getenv("STADIA_API_KEY") ?: throw RuntimeException("API Key not set")

// Defining the host is optional and defaults to https://api.stadiamaps.com
// You can also use our EU endpoint to keep traffic within the EU like so:
// val client = ApiClient(baseUrl = "https://api-eu.stadiamaps.com")
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(RoutingApi::class.java)

// Set up the request.
// Note: this code is blocking for demonstration purposes.
// If you're using Kotlin with coroutines,
// you can also use these asynchronously within suspend functions.
// Synchronous code can enqueue a callback to avoid blocking
// (you'll definitely want to do one of these instead when on the main thread of an app).
// See the docs for details: https://square.github.io/retrofit/2.x/retrofit/retrofit2/Call.html
val locationA = MatrixWaypoint(40.042072, -76.306572)
val locationB = MatrixWaypoint(39.992115, -76.781559)
val locationC = MatrixWaypoint(39.984519, -76.6956)
val costingOptions = CostingOptions(auto = AutoCostingOptions(useHighways = 0.3))  // Take the scenic route ;)

val req = MatrixRequest(
    id = "matrix",
    sources = listOf(locationA),
    targets = listOf(locationB, locationC),
    costing = MatrixCostingModel.auto,
    costingOptions = costingOptions,
)
val res = service.timeDistanceMatrix(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 (1)
    StadiaMapsAPI.customHeaders = ["Authorization": "Stadia-Auth YOUR-API-KEY"]
    // Optionally use our EU endpoint to keep traffic within the EU
    // StadiaMapsAPI.basePath = "https://api-eu.stadiamaps.com"
}

// 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: https://developer.apple.com/documentation/swift/task.
func myFunction() async throws {
    let req = MatrixRequest(id: "matrix",
                            sources: [
                                MatrixWaypoint(lat: 40.042072, lon: -76.306572),
                            ],
                            targets: [
                                MatrixWaypoint(lat: 39.984519, lon: -76.6956),
                                MatrixWaypoint(lat: 39.992115, lon: -76.781559),
                            ],
                            costing: .auto,
                            costingOptions: CostingOptions(auto: AutoCostingOptions(useTolls: 0.3)))  // Take the scenic route :)
    let res = try await RoutingAPI.timeDistanceMatrix(matrixRequest: req)

    // Do something with the response...
    print(res)
}

<?php
// use or require, depending on your installation method.

// Configure API key authorization (replace with your Stadia Maps API key) (1)
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR-API-KEY');
// You can also use our EU endpoint to keep traffic within the EU using setHost:
// $config = Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR-API-KEY')->setHost('https://api-eu.stadiamaps.com');

$apiInstance = new OpenAPI\Client\Api\RoutingApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $req = (new MatrixRequest())
        ->setId('matrix')
        ->setSources([
            (new MatrixWaypoint())->setLat(58.891957)->setLon(22.726262),
            (new MatrixWaypoint())->setLat(59.1558)->setLon(23.762758),
        ])
        ->setTargets([
            (new MatrixWaypoint())->setLat(59.176153)->setLon(23.846605),
            (new MatrixWaypoint())->setLat(59.562853)->setLon(23.096114),
        ])
        ->setCosting(CostingModel::BICYCLE);
    $result = $apiInstance->timeDistanceMatrix($req);
} catch (Exception $e) {
    // Add your error handling here
    echo 'Exception when calling the Stadia Maps API: ', $e->getMessage(), PHP_EOL;
}

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "matrix",
    "sources": [
        {
            "lat": 40.744014,
            "lon": -73.990508
        }
    ],
    "targets": [
        {
            "lat": 40.744014,
            "lon": -73.990508
        },
        {
            "lat": 40.739735,
            "lon": -73.979713
        },
        {
            "lat": 40.752522,
            "lon": -73.985015
        },
        {
            "lat": 40.750117,
            "lon": -73.983704
        },
        {
            "lat": 40.750552,
            "lon": -73.993519
        }
    ],
    "costing": "pedestrian"
}' "https://api.stadiamaps.com/matrix/v1?api_key=YOUR-API-KEY"