## Autocomplete a partial address

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

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

Autocomplete a partial address

### Parameters

- `q: String`

  Partial address query

- `country_code: String`

  ISO 3166-1 alpha-2 country code filter

- `lang: String`

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

- `lat: Float`

  Focus latitude

- `layer: String`

  Filter by layer: address, poi, or admin

- `limit: Integer`

  Maximum results (default 10, max 20)

- `lng: Float`

  Focus longitude

### Returns

- `class AutocompleteResult`

  GeoJSON FeatureCollection of autocomplete suggestions

  - `features: Array[GeocodingFeature]`

    - `geometry: GeoJsonGeometry`

      - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]`

        GeoJSON coordinates array (nesting depth varies by geometry type)

        - `Array[Float]`

        - `Array[Array[Float]]`

        - `Array[Array[Array[Float]]]`

        - `Array[Array[Array[Array[Float]]]]`

      - `type: :Point | :LineString | :Polygon | 3 more`

        - `:Point`

        - `:LineString`

        - `:Polygon`

        - `:MultiPoint`

        - `:MultiLineString`

        - `:MultiPolygon`

    - `properties: { country_code, display_name, distance_m, 4 more}`

      - `country_code: String`

        ISO 3166-1 alpha-2 country code

      - `display_name: String`

        Formatted address or place name

      - `distance_m: Float`

        Distance in meters

      - `osm_id: Integer`

        OpenStreetMap ID

      - `osm_type: String`

        OSM element type

      - `score: Float`

        Match confidence score

      - `source: String`

        Result source (address, place, interpolation)

    - `type: :Feature`

      - `:Feature`

  - `type: :FeatureCollection`

    - `:FeatureCollection`

### Example

```ruby
require "plaza"

plaza = Plaza::Client.new(
  api_key: "My API Key",
  environment: "local" # defaults to "production"
)

autocomplete_result = plaza.geocode.autocomplete(q: "q")

puts(autocomplete_result)
```