Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Geocode

Autocomplete a partial address

AutocompleteResult Geocode.AutocompletePost(GeocodeAutocompletePostParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/geocode/autocomplete

Autocomplete a partial address

ParametersExpand Collapse
GeocodeAutocompletePostParams parameters
required string q

Partial address query

string countryCode

ISO 3166-1 alpha-2 country code filter

string format

Response format: json (default), geojson, csv, ndjson

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 10, max 20)

Double lng

Focus longitude

ReturnsExpand Collapse
class AutocompleteResult:

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

required IReadOnlyList<GeocodingFeature> Features

Autocomplete suggestions ordered by relevance

required GeoJsonGeometry Geometry

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

required Coordinates Coordinates

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

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type

Geometry type

One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties

Geocoding result properties

required string DisplayName

Formatted address or place name

string? Category

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

string? City

City or town name. Present for address results.

Double? Confidence

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

maximum1
minimum0
string? Country

Country name. Present for reverse geocode address results.

string? CountryCode

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
Double? DistanceM

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

string? FullAddress

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

string? HouseNumber

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

Boolean? Interpolated

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

string? Name

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

Long? OsmID

OpenStreetMap element ID (null for interpolated results)

OsmType? OsmType

OSM element type (node, way, relation)

One of the following:
"node"Node
"way"Way
"relation"Relation
string? Postcode

Postal code. Present for reverse geocode address results.

Double? Score

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

minimum0
Source? 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
string? State

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

string? Street

Street name. Present for address and interpolated results.

string? Subcategory

POI subcategory. Present for place results.

IReadOnlyDictionary<string, string>? Tags

Raw OSM tags. Present for place results.

string? Wikipedia

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

required Type Type
required Type Type

Autocomplete a partial address

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

var autocompleteResult = await client.Geocode.AutocompletePost(parameters);

Console.WriteLine(autocompleteResult);
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom",
        "category": "restaurant",
        "city": "London",
        "confidence": 0,
        "country": "United Kingdom",
        "country_code": "GB",
        "distance_m": 0,
        "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom",
        "house_number": "221B",
        "interpolated": true,
        "name": "Eiffel Tower",
        "osm_id": 21154906,
        "osm_type": "node",
        "postcode": "NW1 6XE",
        "score": 0,
        "source": "structured",
        "state": "England",
        "street": "Baker Street",
        "subcategory": "italian",
        "tags": {
          "foo": "string"
        },
        "wikipedia": "en:Eiffel Tower"
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}
Returns Examples
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom",
        "category": "restaurant",
        "city": "London",
        "confidence": 0,
        "country": "United Kingdom",
        "country_code": "GB",
        "distance_m": 0,
        "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom",
        "house_number": "221B",
        "interpolated": true,
        "name": "Eiffel Tower",
        "osm_id": 21154906,
        "osm_type": "node",
        "postcode": "NW1 6XE",
        "score": 0,
        "source": "structured",
        "state": "England",
        "street": "Baker Street",
        "subcategory": "italian",
        "tags": {
          "foo": "string"
        },
        "wikipedia": "en:Eiffel Tower"
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}