Skip to content
GuidesBlogPlaygroundDashboard

Geocode

Forward geocode an address
geocode().forward(GeocodeForwardParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : GeocodeResult
GET/api/v1/geocode
Forward geocode an address
geocode().forwardPost(GeocodeForwardPostParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : GeocodeResult
POST/api/v1/geocode
Reverse geocode a coordinate
geocode().reverse(GeocodeReverseParamsparams = GeocodeReverseParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : ReverseGeocodeResult
GET/api/v1/geocode/reverse
Reverse geocode a coordinate
geocode().reversePost(GeocodeReversePostParamsparams = GeocodeReversePostParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : ReverseGeocodeResult
POST/api/v1/geocode/reverse
Autocomplete a partial address
geocode().autocomplete(GeocodeAutocompleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : AutocompleteResult
GET/api/v1/geocode/autocomplete
Autocomplete a partial address
geocode().autocompletePost(GeocodeAutocompletePostParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : AutocompleteResult
POST/api/v1/geocode/autocomplete
Batch geocode multiple addresses
geocode().batch(GeocodeBatchParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : GeocodeBatchResponse
POST/api/v1/geocode/batch
ModelsExpand Collapse
class AutocompleteResult:

GeoJSON FeatureCollection of autocomplete suggestions for partial address input. Optimized for low-latency type-ahead UIs. Content-Type: application/geo+json.

features: List<GeocodingFeature>

Autocomplete suggestions ordered by relevance

geometry: GeoJsonGeometry

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

coordinates: Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry type

One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
properties: Properties

Geocoding result properties

displayName: String

Formatted address or place name

category: Optional<String>

POI category (e.g. restaurant, cafe, park). Present for place results.

city: Optional<String>

City or town name. Present for address results.

confidence: Optional<Double>

Interpolation confidence (0-1). Present only for interpolated results.

maximum1
minimum0
country: Optional<String>

Country name. Present for reverse geocode address results.

countryCode: Optional<String>

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
distanceM: Optional<Double>

Distance from the query point in meters (reverse geocode / nearby only)

fullAddress: Optional<String>

Complete formatted address from the database. Present for reverse geocode address results.

houseNumber: Optional<String>

House or building number. Present for address and interpolated results.

interpolated: Optional<Boolean>

Whether this result was estimated by address interpolation rather than an exact database match.

name: Optional<String>

Place name (raw). Present for reverse geocode place results.

osmId: Optional<Long>

OpenStreetMap element ID (null for interpolated results)

osmType: Optional<OsmType>

OSM element type (node, way, relation)

One of the following:
NODE("node")
WAY("way")
RELATION("relation")
postcode: Optional<String>

Postal code. Present for reverse geocode address results.

score: Optional<Double>

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

minimum0
source: Optional<Source>

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)

One of the following:
STRUCTURED("structured")
BM25("bm25")
FUZZY("fuzzy")
ADDRESS("address")
PLACE("place")
INTERPOLATION("interpolation")
state: Optional<String>

State or province name. Present for reverse geocode address results.

street: Optional<String>

Street name. Present for address and interpolated results.

subcategory: Optional<String>

POI subcategory. Present for place results.

tags: Optional<Tags>

Raw OSM tags. Present for place results.

wikipedia: Optional<String>

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

type: Type
type: Type
class GeocodeResult:

GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: application/geo+json.

features: List<GeocodingFeature>

Geocoding results ordered by relevance score

geometry: GeoJsonGeometry

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

coordinates: Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry type

One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
properties: Properties

Geocoding result properties

displayName: String

Formatted address or place name

category: Optional<String>

POI category (e.g. restaurant, cafe, park). Present for place results.

city: Optional<String>

City or town name. Present for address results.

confidence: Optional<Double>

Interpolation confidence (0-1). Present only for interpolated results.

maximum1
minimum0
country: Optional<String>

Country name. Present for reverse geocode address results.

countryCode: Optional<String>

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
distanceM: Optional<Double>

Distance from the query point in meters (reverse geocode / nearby only)

fullAddress: Optional<String>

Complete formatted address from the database. Present for reverse geocode address results.

houseNumber: Optional<String>

House or building number. Present for address and interpolated results.

interpolated: Optional<Boolean>

Whether this result was estimated by address interpolation rather than an exact database match.

name: Optional<String>

Place name (raw). Present for reverse geocode place results.

osmId: Optional<Long>

OpenStreetMap element ID (null for interpolated results)

osmType: Optional<OsmType>

OSM element type (node, way, relation)

One of the following:
NODE("node")
WAY("way")
RELATION("relation")
postcode: Optional<String>

Postal code. Present for reverse geocode address results.

score: Optional<Double>

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

minimum0
source: Optional<Source>

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)

One of the following:
STRUCTURED("structured")
BM25("bm25")
FUZZY("fuzzy")
ADDRESS("address")
PLACE("place")
INTERPOLATION("interpolation")
state: Optional<String>

State or province name. Present for reverse geocode address results.

street: Optional<String>

Street name. Present for address and interpolated results.

subcategory: Optional<String>

POI subcategory. Present for place results.

tags: Optional<Tags>

Raw OSM tags. Present for place results.

wikipedia: Optional<String>

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

type: Type
type: Type
class GeocodingFeature:

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: GeoJsonGeometry

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

coordinates: Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry type

One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
properties: Properties

Geocoding result properties

displayName: String

Formatted address or place name

category: Optional<String>

POI category (e.g. restaurant, cafe, park). Present for place results.

city: Optional<String>

City or town name. Present for address results.

confidence: Optional<Double>

Interpolation confidence (0-1). Present only for interpolated results.

maximum1
minimum0
country: Optional<String>

Country name. Present for reverse geocode address results.

countryCode: Optional<String>

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
distanceM: Optional<Double>

Distance from the query point in meters (reverse geocode / nearby only)

fullAddress: Optional<String>

Complete formatted address from the database. Present for reverse geocode address results.

houseNumber: Optional<String>

House or building number. Present for address and interpolated results.

interpolated: Optional<Boolean>

Whether this result was estimated by address interpolation rather than an exact database match.

name: Optional<String>

Place name (raw). Present for reverse geocode place results.

osmId: Optional<Long>

OpenStreetMap element ID (null for interpolated results)

osmType: Optional<OsmType>

OSM element type (node, way, relation)

One of the following:
NODE("node")
WAY("way")
RELATION("relation")
postcode: Optional<String>

Postal code. Present for reverse geocode address results.

score: Optional<Double>

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

minimum0
source: Optional<Source>

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)

One of the following:
STRUCTURED("structured")
BM25("bm25")
FUZZY("fuzzy")
ADDRESS("address")
PLACE("place")
INTERPOLATION("interpolation")
state: Optional<String>

State or province name. Present for reverse geocode address results.

street: Optional<String>

Street name. Present for address and interpolated results.

subcategory: Optional<String>

POI subcategory. Present for place results.

tags: Optional<Tags>

Raw OSM tags. Present for place results.

wikipedia: Optional<String>

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

type: Type
class ReverseGeocodeResult:

GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: application/geo+json.

features: List<GeocodingFeature>

Reverse geocoding results ordered by distance

geometry: GeoJsonGeometry

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

coordinates: Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry type

One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
properties: Properties

Geocoding result properties

displayName: String

Formatted address or place name

category: Optional<String>

POI category (e.g. restaurant, cafe, park). Present for place results.

city: Optional<String>

City or town name. Present for address results.

confidence: Optional<Double>

Interpolation confidence (0-1). Present only for interpolated results.

maximum1
minimum0
country: Optional<String>

Country name. Present for reverse geocode address results.

countryCode: Optional<String>

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
distanceM: Optional<Double>

Distance from the query point in meters (reverse geocode / nearby only)

fullAddress: Optional<String>

Complete formatted address from the database. Present for reverse geocode address results.

houseNumber: Optional<String>

House or building number. Present for address and interpolated results.

interpolated: Optional<Boolean>

Whether this result was estimated by address interpolation rather than an exact database match.

name: Optional<String>

Place name (raw). Present for reverse geocode place results.

osmId: Optional<Long>

OpenStreetMap element ID (null for interpolated results)

osmType: Optional<OsmType>

OSM element type (node, way, relation)

One of the following:
NODE("node")
WAY("way")
RELATION("relation")
postcode: Optional<String>

Postal code. Present for reverse geocode address results.

score: Optional<Double>

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

minimum0
source: Optional<Source>

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)

One of the following:
STRUCTURED("structured")
BM25("bm25")
FUZZY("fuzzy")
ADDRESS("address")
PLACE("place")
INTERPOLATION("interpolation")
state: Optional<String>

State or province name. Present for reverse geocode address results.

street: Optional<String>

Street name. Present for address and interpolated results.

subcategory: Optional<String>

POI subcategory. Present for place results.

tags: Optional<Tags>

Raw OSM tags. Present for place results.

wikipedia: Optional<String>

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

type: Type
type: Type