API Reference

Geocode

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Autocomplete a partial address

AutocompleteResult geocode().autocomplete(GeocodeAutocompleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/geocode/autocomplete

Autocomplete a partial address

ParametersExpand Collapse

GeocodeAutocompleteParams params

String q

Partial address query

Optional<String> countryCode

ISO 3166-1 alpha-2 country code filter

Optional<String> format

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

Optional<String> lang

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

Optional<Double> lat

Focus latitude

Optional<String> layer

Filter by layer: address, poi, or admin

Optional<Long> limit

Maximum results (default 10, max 20)

Optional<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.

List<GeocodingFeature> features

Autocomplete suggestions ordered by relevance

GeoJsonGeometry geometry

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

Coordinates coordinates

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

One of the following:

List<double>

List<List<double>>

List<List<List<double>>>

List<List<List<List<double>>>>

Type type

Geometry type

One of the following:

POINT("Point")

LINE_STRING("LineString")

POLYGON("Polygon")

MULTI_POINT("MultiPoint")

MULTI_LINE_STRING("MultiLineString")

MULTI_POLYGON("MultiPolygon")

Properties properties

Geocoding result properties

String displayName

Formatted address or place name

Optional<String> category

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

Optional<String> city

City or town name. Present for address results.

Optional<Double> confidence

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

maximum1

minimum0

Optional<String> country

Country name. Present for reverse geocode address results.

Optional<String> countryCode

ISO 3166-1 alpha-2 country code

maxLength2

minLength2

Optional<Double> distanceM

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

Optional<String> fullAddress

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

Optional<String> houseNumber

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

Optional<Boolean> interpolated

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

Optional<String> name

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

Optional<Long> osmId

OpenStreetMap element ID (null for interpolated results)

Optional<OsmType> osmType

OSM element type (node, way, relation)

One of the following:

NODE("node")

WAY("way")

RELATION("relation")

Optional<String> postcode

Postal code. Present for reverse geocode address results.

Optional<Double> score

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

minimum0

Optional<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")

Optional<String> state

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

Optional<String> street

Street name. Present for address and interpolated results.

Optional<String> subcategory

POI subcategory. Present for place results.

Optional<Tags> tags

Raw OSM tags. Present for place results.

Optional<String> wikipedia

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

Type type

Type type

Autocomplete a partial address

Java

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package com.plazafyi.example;

import com.plazafyi.client.PlazaClient;
import com.plazafyi.client.okhttp.PlazaOkHttpClient;
import com.plazafyi.models.geocode.AutocompleteResult;
import com.plazafyi.models.geocode.GeocodeAutocompleteParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        PlazaClient client = PlazaOkHttpClient.fromEnv();

        GeocodeAutocompleteParams params = GeocodeAutocompleteParams.builder()
            .q("q")
            .build();
        AutocompleteResult autocompleteResult = client.geocode().autocomplete(params);
    }
}

200 example

{
  "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

200 example

{
  "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"
}