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

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

GET/api/v1/nearest

Snap a coordinate to the nearest road

ParametersExpand Collapse

params: RoutingNearestParams

lat: Double

Latitude

lng: Double

Longitude

radius: Optional<Long>

Search radius in meters (default 500, max 5000)

ReturnsExpand Collapse

class NearestResult:

GeoJSON Point Feature snapped to the nearest road segment

geometry: GeoJsonGeometry

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

distanceM: Optional<Double>

Distance to nearest road in meters

edgeId: Optional<Long>

Road edge ID

type: Type

Snap a coordinate to the nearest road

Kotlin

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

fun main() {
    val client: PlazaClient = PlazaOkHttpClient.fromEnv()

    val params: RoutingNearestParams = RoutingNearestParams.builder()
        .lat(0.0)
        .lng(0.0)
        .build()
    val 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"
}