API Reference

Routing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Snap a coordinate to the nearest road

NearestResult routing().nearest(RoutingNearestParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/nearest

Snap a coordinate to the nearest road

ParametersExpand Collapse

RoutingNearestParams params

double lat

Latitude

double lng

Longitude

Optional<Long> radius

Search radius in meters (default 500, max 5000)

ReturnsExpand Collapse

class NearestResult:

GeoJSON Point Feature snapped to the nearest road segment

GeoJsonGeometry geometry

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

List<double>

List<List<double>>

List<List<List<double>>>

List<List<List<List<double>>>>

Type type

One of the following:

POINT("Point")

LINE_STRING("LineString")

POLYGON("Polygon")

MULTI_POINT("MultiPoint")

MULTI_LINE_STRING("MultiLineString")

MULTI_POLYGON("MultiPolygon")

Properties properties

Optional<Double> distanceM

Distance to nearest road in meters

Optional<Long> edgeId

Road edge ID

Type type

Snap a coordinate to the nearest road

Java

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package com.plazafyi.example;

import com.plazafyi.client.PlazaClient;
import com.plazafyi.client.okhttp.PlazaOkHttpClient;
import com.plazafyi.models.routing.NearestResult;
import com.plazafyi.models.routing.RoutingNearestParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        PlazaClient client = PlazaOkHttpClient.fromEnv();

        RoutingNearestParams params = RoutingNearestParams.builder()
            .lat(0.0)
            .lng(0.0)
            .build();
        NearestResult nearestResult = client.routing().nearest(params);
    }
}

200 example

{
  "geometry": {
    "coordinates": [
      0
    ],
    "type": "Point"
  },
  "properties": {
    "distance_m": 0,
    "edge_id": 0
  },
  "type": "Feature"
}

Returns Examples

200 example

{
  "geometry": {
    "coordinates": [
      0
    ],
    "type": "Point"
  },
  "properties": {
    "distance_m": 0,
    "edge_id": 0
  },
  "type": "Feature"
}