locate
Snap one coordinate to the road network and return the matched road's context: name, road class, speed limit, bearing, snap distance, side of street, truck legality, and toll/ferry/highway/bridge/tunnel flags — plus the IANA timezone. Use to answer 'what road is this point on and what are its rules?' for fleet/telematics snapping, geofence edge checks, or enriching a GPS fix. Set include_elevation for terrain-sourced point elevation_m; grade_pct is a forward-compatible field that stays null for now. Read road_status, not matched alone: matched — a road was found and road is filled; no_road_nearby — a real answer: no routable road is near the point for this travel profile; unavailable — the road lookup could not be answered right now, so matched:false / road:null say nothing about the point, retryable is true, and the timezone and any requested elevation are still looked up separately (see timezone_status and warnings). Never a guess.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lat | Yes | Latitude | |
| lon | Yes | Longitude | |
| units | No | Unit system for the human summary — auto-detected (US/UK → imperial) when omitted. | |
| costing | No | Travel profile scoping edge access/legality. Default 'auto'. | |
| include_elevation | No | Opt-in to point elevation — populates elevation_m/elevation_ft from terrain data (null with an 'elevation_unavailable' warning only where terrain isn't covered). grade_pct is a forward-compatible field that stays null for now (reserved for an elevation-enhanced road network). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | No | ||
| road | No | ||
| items | No | ||
| geojson | No | ||
| matched | No | ||
| metrics | No | ||
| summary | No | ||
| location | No | ||
| timezone | No | IANA timezone for the point, or null unless timezone_status is resolved. Contains information from timezone-boundary-builder, which is made available under the Open Database License (ODbL) v1.0. Timezone boundaries © OpenStreetMap contributors. US legal-zone cross-check: U.S. Department of Transportation, Bureau of Transportation Statistics (public domain). | |
| warnings | No | ||
| grade_pct | No | ||
| retryable | No | Present and true only when `road_status` is `unavailable`: the same call may succeed shortly. | |
| elevation_m | No | ||
| road_status | No | Why `road` is what it is. `matched`: a routable road was found. `no_road_nearby`: the lookup answered and found no routable road near the point for this travel profile. `unavailable`: the road lookup could not be answered right now; this says nothing about the point, `retryable` is true, and the timezone and any requested elevation are still looked up separately. | |
| display_hint | No | ||
| elevation_ft | No | ||
| timezone_status | No | ||
| timezone_artifact_version | No |