## Forward geocode an address

`geocode().forward(GeocodeForwardParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : GeocodeResult`

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

Forward geocode an address

### Parameters

- `params: GeocodeForwardParams`

  - `q: String`

    Address or place name

  - `bbox: Optional<String>`

    Bounding box filter: south,west,north,east

  - `countryCode: Optional<String>`

    ISO 3166-1 alpha-2 country code filter

  - `lang: Optional<String>`

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

  - `lat: Optional<Double>`

    Focus latitude

  - `layer: Optional<String>`

    Filter by layer: address, poi, or admin

  - `limit: Optional<Long>`

    Maximum results (default 20, max 100)

  - `lng: Optional<Double>`

    Focus longitude

### Returns

- `class GeocodeResult:`

  GeoJSON FeatureCollection of geocoding results

  - `features: List<GeocodingFeature>`

    - `geometry: GeoJsonGeometry`

      - `coordinates: Coordinates`

        GeoJSON coordinates array (nesting depth varies by geometry type)

        - `List<Double>`

        - `List<List<Double>>`

        - `List<List<List<Double>>>`

        - `List<List<List<List<Double>>>>`

      - `type: Type`

        - `POINT("Point")`

        - `LINE_STRING("LineString")`

        - `POLYGON("Polygon")`

        - `MULTI_POINT("MultiPoint")`

        - `MULTI_LINE_STRING("MultiLineString")`

        - `MULTI_POLYGON("MultiPolygon")`

    - `properties: Properties`

      - `countryCode: Optional<String>`

        ISO 3166-1 alpha-2 country code

      - `displayName: Optional<String>`

        Formatted address or place name

      - `distanceM: Optional<Double>`

        Distance in meters

      - `osmId: Optional<Long>`

        OpenStreetMap ID

      - `osmType: Optional<String>`

        OSM element type

      - `score: Optional<Double>`

        Match confidence score

      - `source: Optional<String>`

        Result source (address, place, interpolation)

    - `type: Type`

      - `FEATURE("Feature")`

  - `type: Type`

    - `FEATURE_COLLECTION("FeatureCollection")`

### Example

```kotlin
package com.plazafyi.example

import com.plazafyi.client.PlazaClient
import com.plazafyi.client.okhttp.PlazaOkHttpClient
import com.plazafyi.models.geocode.GeocodeForwardParams
import com.plazafyi.models.geocode.GeocodeResult

fun main() {
    val client: PlazaClient = PlazaOkHttpClient.fromEnv()

    val params: GeocodeForwardParams = GeocodeForwardParams.builder()
        .q("q")
        .build()
    val geocodeResult: GeocodeResult = client.geocode().forward(params)
}
```