## Autocomplete a partial address

`geocode.autocomplete(GeocodeAutocompleteParams**kwargs)  -> AutocompleteResult`

**get** `/api/v1/geocode/autocomplete`

Autocomplete a partial address

### Parameters

- `q: str`

  Partial address query

- `country_code: Optional[str]`

  ISO 3166-1 alpha-2 country code filter

- `lang: Optional[str]`

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

- `lat: Optional[float]`

  Focus latitude

- `layer: Optional[str]`

  Filter by layer: address, poi, or admin

- `limit: Optional[int]`

  Maximum results (default 10, max 20)

- `lng: Optional[float]`

  Focus longitude

### Returns

- `class AutocompleteResult: …`

  GeoJSON FeatureCollection of autocomplete suggestions

  - `features: List[GeocodingFeature]`

    - `geometry: GeoJsonGeometry`

      - `coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]`

        GeoJSON coordinates array (nesting depth varies by geometry type)

        - `List[float]`

        - `List[List[float]]`

        - `List[List[List[float]]]`

        - `List[List[List[List[float]]]]`

      - `type: Literal["Point", "LineString", "Polygon", 3 more]`

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      - `country_code: Optional[str]`

        ISO 3166-1 alpha-2 country code

      - `display_name: Optional[str]`

        Formatted address or place name

      - `distance_m: Optional[float]`

        Distance in meters

      - `osm_id: Optional[int]`

        OpenStreetMap ID

      - `osm_type: Optional[str]`

        OSM element type

      - `score: Optional[float]`

        Match confidence score

      - `source: Optional[str]`

        Result source (address, place, interpolation)

    - `type: Literal["Feature"]`

      - `"Feature"`

  - `type: Literal["FeatureCollection"]`

    - `"FeatureCollection"`

### Example

```python
import os
from plaza import Plaza

client = Plaza(
    api_key=os.environ.get("PLAZA_API_KEY"),  # This is the default and can be omitted
)
autocomplete_result = client.geocode.autocomplete(
    q="q",
)
print(autocomplete_result.features)
```