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

$client->routing->nearestPost(float lat, float lng, ?string outputFields, ?string outputInclude, ?int outputPrecision, ?int radius): NearestResult

POST/api/v1/nearest

Snap a coordinate to the nearest road

ParametersExpand Collapse

lat: float

Latitude

lng: float

Longitude

outputFields?:optional string

Comma-separated property fields to include

outputInclude?:optional string

Extra computed fields: bbox, distance, center

outputPrecision?:optional int

Coordinate decimal precision (1-15, default 7)

radius?:optional int

Search radius in meters (default 500, max 5000)

ReturnsExpand Collapse

NearestResult

GeoJsonGeometry geometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

Properties properties

Snap result metadata

Type type

Snap a coordinate to the nearest road

PHP

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'local');

$nearestResult = $client->routing->nearestPost(
  lat: 0,
  lng: 0,
  outputFields: 'output[fields]',
  outputInclude: 'output[include]',
  outputPrecision: 0,
  radius: 0,
);

var_dump($nearestResult);

200 example

{
  "geometry": {
    "coordinates": [
      2.3522,
      48.8566
    ],
    "type": "Point"
  },
  "properties": {
    "distance_m": 12.4,
    "edge_id": 0,
    "edge_length_m": 0,
    "highway": "highway",
    "osm_way_id": 0,
    "surface": "surface"
  },
  "type": "Feature"
}

Returns Examples

200 example

{
  "geometry": {
    "coordinates": [
      2.3522,
      48.8566
    ],
    "type": "Point"
  },
  "properties": {
    "distance_m": 12.4,
    "edge_id": 0,
    "edge_length_m": 0,
    "highway": "highway",
    "osm_way_id": 0,
    "surface": "surface"
  },
  "type": "Feature"
}