Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Geocode

Forward geocode an address
GeocodeResult Geocode.Forward(GeocodeForwardParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/geocode
Reverse geocode a coordinate
ReverseGeocodeResult Geocode.Reverse(GeocodeReverseParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/geocode/reverse
Autocomplete a partial address
AutocompleteResult Geocode.Autocomplete(GeocodeAutocompleteParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/geocode/autocomplete
Batch geocode multiple addresses
JsonElement Geocode.Batch(GeocodeBatchParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/geocode/batch
ModelsExpand Collapse
class AutocompleteResult:

GeoJSON FeatureCollection of autocomplete suggestions

required IReadOnlyList<GeocodingFeature> Features
required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
string? CountryCode

ISO 3166-1 alpha-2 country code

string DisplayName

Formatted address or place name

Double? DistanceM

Distance in meters

Long? OsmID

OpenStreetMap ID

string? OsmType

OSM element type

Double? Score

Match confidence score

string? Source

Result source (address, place, interpolation)

required Type Type
required Type Type
class GeocodeResult:

GeoJSON FeatureCollection of geocoding results

required IReadOnlyList<GeocodingFeature> Features
required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
string? CountryCode

ISO 3166-1 alpha-2 country code

string DisplayName

Formatted address or place name

Double? DistanceM

Distance in meters

Long? OsmID

OpenStreetMap ID

string? OsmType

OSM element type

Double? Score

Match confidence score

string? Source

Result source (address, place, interpolation)

required Type Type
required Type Type
class GeocodingFeature:
required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
string? CountryCode

ISO 3166-1 alpha-2 country code

string DisplayName

Formatted address or place name

Double? DistanceM

Distance in meters

Long? OsmID

OpenStreetMap ID

string? OsmType

OSM element type

Double? Score

Match confidence score

string? Source

Result source (address, place, interpolation)

required Type Type
class ReverseGeocodeResult:

GeoJSON FeatureCollection of reverse geocoding results

required IReadOnlyList<GeocodingFeature> Features
required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
string? CountryCode

ISO 3166-1 alpha-2 country code

string DisplayName

Formatted address or place name

Double? DistanceM

Distance in meters

Long? OsmID

OpenStreetMap ID

string? OsmType

OSM element type

Double? Score

Match confidence score

string? Source

Result source (address, place, interpolation)

required Type Type
required Type Type