Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Geocode

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

GeoJSON FeatureCollection of autocomplete suggestions

features: List<GeocodingFeature>
geometry: GeoJsonGeometry
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
countryCode: Optional<String>

ISO 3166-1 alpha-2 country code

displayName: Optional<String>

Formatted address or place name

distanceM: Optional<Double>

Distance in meters

osmId: Optional<Long>

OpenStreetMap ID

osmType: Optional<String>

OSM element type

score: Optional<Double>

Match confidence score

source: Optional<String>

Result source (address, place, interpolation)

type: Type
type: Type
class GeocodeResult:

GeoJSON FeatureCollection of geocoding results

features: List<GeocodingFeature>
geometry: GeoJsonGeometry
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
countryCode: Optional<String>

ISO 3166-1 alpha-2 country code

displayName: Optional<String>

Formatted address or place name

distanceM: Optional<Double>

Distance in meters

osmId: Optional<Long>

OpenStreetMap ID

osmType: Optional<String>

OSM element type

score: Optional<Double>

Match confidence score

source: Optional<String>

Result source (address, place, interpolation)

type: Type
type: Type
class GeocodingFeature:
geometry: GeoJsonGeometry
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
countryCode: Optional<String>

ISO 3166-1 alpha-2 country code

displayName: Optional<String>

Formatted address or place name

distanceM: Optional<Double>

Distance in meters

osmId: Optional<Long>

OpenStreetMap ID

osmType: Optional<String>

OSM element type

score: Optional<Double>

Match confidence score

source: Optional<String>

Result source (address, place, interpolation)

type: Type
class ReverseGeocodeResult:

GeoJSON FeatureCollection of reverse geocoding results

features: List<GeocodingFeature>
geometry: GeoJsonGeometry
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
countryCode: Optional<String>

ISO 3166-1 alpha-2 country code

displayName: Optional<String>

Formatted address or place name

distanceM: Optional<Double>

Distance in meters

osmId: Optional<Long>

OpenStreetMap ID

osmType: Optional<String>

OSM element type

score: Optional<Double>

Match confidence score

source: Optional<String>

Result source (address, place, interpolation)

type: Type
type: Type