Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Geocode

Autocomplete a partial address

client.geocode.autocomplete(GeocodeAutocompleteParams { q, country_code, format, 5 more } query, RequestOptionsoptions?): AutocompleteResult { features, type }
GET/api/v1/geocode/autocomplete

Autocomplete a partial address

ParametersExpand Collapse
query: GeocodeAutocompleteParams { q, country_code, format, 5 more }
q: string

Partial address query

country_code?: string

ISO 3166-1 alpha-2 country code filter

format?: string

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

lang?: string

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

lat?: number

Focus latitude

layer?: string

Filter by layer: address, poi, or admin

limit?: number

Maximum results (default 10, max 20)

lng?: number

Focus longitude

ReturnsExpand Collapse
AutocompleteResult { features, type }

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

features: Array<GeocodingFeature { geometry, properties, type } >

Autocomplete suggestions ordered by relevance

geometry: GeoJsonGeometry { coordinates, type }

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

coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

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

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more

Geometry type

One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties { display_name, category, city, 18 more }

Geocoding result properties

display_name: string

Formatted address or place name

category?: string | null

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

city?: string | null

City or town name. Present for address results.

confidence?: number | null

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

maximum1
minimum0
country?: string | null

Country name. Present for reverse geocode address results.

country_code?: string | null

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
distance_m?: number | null

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

full_address?: string | null

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

house_number?: string | null

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

interpolated?: boolean | null

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

name?: string | null

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

osm_id?: number | null

OpenStreetMap element ID (null for interpolated results)

osm_type?: "node" | "way" | "relation" | null

OSM element type (node, way, relation)

One of the following:
"node"
"way"
"relation"
postcode?: string | null

Postal code. Present for reverse geocode address results.

score?: number | null

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

minimum0
source?: "structured" | "bm25" | "fuzzy" | 3 more | null

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"
"bm25"
"fuzzy"
"address"
"place"
"interpolation"
state?: string | null

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

street?: string | null

Street name. Present for address and interpolated results.

subcategory?: string | null

POI subcategory. Present for place results.

tags?: Record<string, string> | null

Raw OSM tags. Present for place results.

wikipedia?: string | null

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

type: "Feature"
type: "FeatureCollection"

Autocomplete a partial address

import Plaza from '@plazafyi/sdk';

const client = new Plaza({
  apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted
});

const autocompleteResult = await client.geocode.autocomplete({ q: 'q' });

console.log(autocompleteResult.features);
{
  "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"
}