Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Geocode

Forward geocode an address

GeocodeResult Geocode.Forward(GeocodeForwardParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/geocode

Forward geocode an address

ParametersExpand Collapse
GeocodeForwardParams parameters
required string q

Address or place name

string bbox

Bounding box filter: south,west,north,east

string countryCode

ISO 3166-1 alpha-2 country code filter

string lang

Language code for localized names (e.g. en, de, fr)

Double lat

Focus latitude

string layer

Filter by layer: address, poi, or admin

Long limit

Maximum results (default 20, max 100)

Double lng

Focus longitude

ReturnsExpand Collapse
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

Forward geocode an address

GeocodeForwardParams parameters = new() { Q = "q" };

var geocodeResult = await client.Geocode.Forward(parameters);

Console.WriteLine(geocodeResult);
Returns Examples