Skip to content

Nearest Roads





Our Nearest Roads API helps you find detailed information about streets and intersections near one or more locations. The search can be filtered if desired (ex: to exclude unpaved roads), and is extremely useful in "free-roaming" navigation applications.

Here are some of the information you can find using the Nearest Roads API:

  • Snapped coordinates on the road network
  • Percent along the current edge (road segment)
  • OpenStreetMap way IDs for cross-referencing
  • Optional detailed edge info
    • OpenLR location references
    • Name and network information
    • Speed information (both estimated and posted limits, where available)
    • Road classification and surface info
    • And more!


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, NearestRoadsRequest } 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();

// A map match request using an encoded polyline. You can also use a list of coordinates to specify the shape.
const req: NearestRoadsRequest = {
    locations: [
            lat: 59.436884,
            lon: 24.742595
    verbose: true
const res = await api.nearestRoads({ nearestRoadsRequest: 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)

        req = stadiamaps.NearestRoadsRequest(
            locations=[{"lat": 40.042072, "lon": -76.306572}]

        res = api_instance.nearest_roads(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 req = NearestRoadsRequest(locations = listOf(Coordinate(40.042072, -76.306572), Coordinate(39.992115, -76.781559)))
val res = service.nearestRoads(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 = NearestRoadsRequest(locations: [Coordinate(lat: 40.042072, lon: -76.306572)])
    let res = try await RoutingAPI.nearestRoads(nearestRoadsRequest: req)

    // Do something with the response...
curl -X POST -H "Content-Type: application/json" -d '{
    "locations": [
            "lat": 59.436884,
            "lon": 24.742595
    "verbose": true
}' ""

Complementary APIs

This endpoint is designed to work in tandem with standard routing and optimized routing. It may also be useful to combine with forward geocoding or structured geocoding to get road or intersection information near an address.

Next Steps