Geocode
ModelsExpand Collapse
autocomplete_result: object { features, type } GeoJSON FeatureCollection of autocomplete suggestions for partial address input. Optimized for low-latency type-ahead UIs. Content-Type: application/geo+json.
GeoJSON FeatureCollection of autocomplete suggestions for partial address input. Optimized for low-latency type-ahead UIs. Content-Type: application/geo+json.
Autocomplete suggestions ordered by relevance
Autocomplete suggestions ordered by relevance
geometry: object { coordinates, type } GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.
GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.
properties: object { display_name, category, city, 18 more } Geocoding result properties
Geocoding result properties
Complete formatted address from the database. Present for reverse geocode address results.
House or building number. Present for address and interpolated results.
Whether this result was estimated by address interpolation rather than an exact database match.
Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.
source: optional "structured" or "bm25" or "fuzzy" or 3 moreResult source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)
Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)
geocode_result: object { features, type } GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: application/geo+json.
GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: application/geo+json.
Geocoding results ordered by relevance score
Geocoding results ordered by relevance score
geometry: object { coordinates, type } GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.
GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.
properties: object { display_name, category, city, 18 more } Geocoding result properties
Geocoding result properties
Complete formatted address from the database. Present for reverse geocode address results.
House or building number. Present for address and interpolated results.
Whether this result was estimated by address interpolation rather than an exact database match.
Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.
source: optional "structured" or "bm25" or "fuzzy" or 3 moreResult source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)
Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)
geocoding_feature: object { geometry, properties, type } GeoJSON Feature representing a geocoding result. The geometry is always a Point. Properties include the formatted display name, OSM metadata, confidence score, and source type.
GeoJSON Feature representing a geocoding result. The geometry is always a Point. Properties include the formatted display name, OSM metadata, confidence score, and source type.
geometry: object { coordinates, type } GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.
GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.
properties: object { display_name, category, city, 18 more } Geocoding result properties
Geocoding result properties
Complete formatted address from the database. Present for reverse geocode address results.
House or building number. Present for address and interpolated results.
Whether this result was estimated by address interpolation rather than an exact database match.
Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.
source: optional "structured" or "bm25" or "fuzzy" or 3 moreResult source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)
Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)
reverse_geocode_result: object { features, type } GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: application/geo+json.
GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: application/geo+json.
Reverse geocoding results ordered by distance
Reverse geocoding results ordered by distance
geometry: object { coordinates, type } GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.
GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.
properties: object { display_name, category, city, 18 more } Geocoding result properties
Geocoding result properties
Complete formatted address from the database. Present for reverse geocode address results.
House or building number. Present for address and interpolated results.
Whether this result was estimated by address interpolation rather than an exact database match.
Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.
source: optional "structured" or "bm25" or "fuzzy" or 3 moreResult source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)
Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)