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. Returns matched:false when no routable road is near the point — 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 | ||
| warnings | No | ||
| grade_pct | No | ||
| elevation_m | No | ||
| display_hint | No | ||
| elevation_ft | No |