Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Geocode

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

GeoJSON FeatureCollection of autocomplete suggestions

List<GeocodingFeature> features
Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<String> countryCode

ISO 3166-1 alpha-2 country code

Optional<String> displayName

Formatted address or place name

Optional<Double> distanceM

Distance in meters

Optional<Long> osmId

OpenStreetMap ID

Optional<String> osmType

OSM element type

Optional<Double> score

Match confidence score

Optional<String> source

Result source (address, place, interpolation)

Type type
Type type
class GeocodeResult:

GeoJSON FeatureCollection of geocoding results

List<GeocodingFeature> features
Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<String> countryCode

ISO 3166-1 alpha-2 country code

Optional<String> displayName

Formatted address or place name

Optional<Double> distanceM

Distance in meters

Optional<Long> osmId

OpenStreetMap ID

Optional<String> osmType

OSM element type

Optional<Double> score

Match confidence score

Optional<String> source

Result source (address, place, interpolation)

Type type
Type type
class GeocodingFeature:
Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<String> countryCode

ISO 3166-1 alpha-2 country code

Optional<String> displayName

Formatted address or place name

Optional<Double> distanceM

Distance in meters

Optional<Long> osmId

OpenStreetMap ID

Optional<String> osmType

OSM element type

Optional<Double> score

Match confidence score

Optional<String> source

Result source (address, place, interpolation)

Type type
class ReverseGeocodeResult:

GeoJSON FeatureCollection of reverse geocoding results

List<GeocodingFeature> features
Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<String> countryCode

ISO 3166-1 alpha-2 country code

Optional<String> displayName

Formatted address or place name

Optional<Double> distanceM

Distance in meters

Optional<Long> osmId

OpenStreetMap ID

Optional<String> osmType

OSM element type

Optional<Double> score

Match confidence score

Optional<String> source

Result source (address, place, interpolation)

Type type
Type type