# Geocode

## Forward geocode an address

`client.geocode.forward(GeocodeForwardParamsquery, RequestOptionsoptions?): GeocodeResult`

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

Forward geocode an address

### Parameters

- `query: GeocodeForwardParams`

  - `q: string`

    Address or place name

  - `bbox?: string`

    Bounding box filter: south,west,north,east

  - `country_code?: string`

    ISO 3166-1 alpha-2 country code filter

  - `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 20, max 100)

  - `lng?: number`

    Focus longitude

### Returns

- `GeocodeResult`

  GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: `application/geo+json`.

  - `features: Array<GeocodingFeature>`

    Geocoding results ordered by relevance score

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```typescript
import Plaza from '@plazafyi/sdk';

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

const geocodeResult = await client.geocode.forward({ q: 'q' });

console.log(geocodeResult.features);
```

#### Response

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

## Forward geocode an address

`client.geocode.forwardPost(GeocodeForwardPostParamsparams, RequestOptionsoptions?): GeocodeResult`

**post** `/api/v1/geocode`

Forward geocode an address

### Parameters

- `params: GeocodeForwardPostParams`

  - `q: string`

    Address or place name

  - `bbox?: string`

    Bounding box filter: south,west,north,east

  - `country_code?: string`

    ISO 3166-1 alpha-2 country code filter

  - `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 20, max 100)

  - `lng?: number`

    Focus longitude

### Returns

- `GeocodeResult`

  GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: `application/geo+json`.

  - `features: Array<GeocodingFeature>`

    Geocoding results ordered by relevance score

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```typescript
import Plaza from '@plazafyi/sdk';

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

const geocodeResult = await client.geocode.forwardPost({ q: 'q' });

console.log(geocodeResult.features);
```

#### Response

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

## Reverse geocode a coordinate

`client.geocode.reverse(GeocodeReverseParamsquery?, RequestOptionsoptions?): ReverseGeocodeResult`

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

Reverse geocode a coordinate

### Parameters

- `query: GeocodeReverseParams`

  - `lang?: string`

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

  - `lat?: number`

    Legacy shorthand. Latitude. Use near param instead.

  - `layer?: string`

    Filter by layer: house or poi

  - `limit?: number`

    Maximum results (default 1, max 20)

  - `lng?: number`

    Legacy shorthand. Longitude. Use near param instead.

  - `near?: string`

    Point geometry for reverse geocode (lat,lng or GeoJSON). Alternative to lat/lng params.

  - `radius?: number`

    Search radius in meters (default 200, max 5000)

### Returns

- `ReverseGeocodeResult`

  GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: `application/geo+json`.

  - `features: Array<GeocodingFeature>`

    Reverse geocoding results ordered by distance

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```typescript
import Plaza from '@plazafyi/sdk';

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

const reverseGeocodeResult = await client.geocode.reverse();

console.log(reverseGeocodeResult.features);
```

#### Response

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

## Reverse geocode a coordinate

`client.geocode.reversePost(GeocodeReversePostParamsparams?, RequestOptionsoptions?): ReverseGeocodeResult`

**post** `/api/v1/geocode/reverse`

Reverse geocode a coordinate

### Parameters

- `params: GeocodeReversePostParams`

  - `lang?: string`

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

  - `lat?: number`

    Legacy shorthand. Latitude. Use near param instead.

  - `layer?: string`

    Filter by layer: house or poi

  - `limit?: number`

    Maximum results (default 1, max 20)

  - `lng?: number`

    Legacy shorthand. Longitude. Use near param instead.

  - `near?: string`

    Point geometry for reverse geocode (lat,lng or GeoJSON). Alternative to lat/lng params.

  - `radius?: number`

    Search radius in meters (default 200, max 5000)

### Returns

- `ReverseGeocodeResult`

  GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: `application/geo+json`.

  - `features: Array<GeocodingFeature>`

    Reverse geocoding results ordered by distance

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```typescript
import Plaza from '@plazafyi/sdk';

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

const reverseGeocodeResult = await client.geocode.reversePost();

console.log(reverseGeocodeResult.features);
```

#### Response

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

## Autocomplete a partial address

`client.geocode.autocomplete(GeocodeAutocompleteParamsquery, RequestOptionsoptions?): AutocompleteResult`

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

Autocomplete a partial address

### Parameters

- `query: GeocodeAutocompleteParams`

  - `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?: number`

    Focus latitude

  - `layer?: string`

    Filter by layer: address, poi, or admin

  - `limit?: number`

    Maximum results (default 10, max 20)

  - `lng?: number`

    Focus longitude

### Returns

- `AutocompleteResult`

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

  - `features: Array<GeocodingFeature>`

    Autocomplete suggestions ordered by relevance

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```typescript
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);
```

#### Response

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

## Autocomplete a partial address

`client.geocode.autocompletePost(GeocodeAutocompletePostParamsparams, RequestOptionsoptions?): AutocompleteResult`

**post** `/api/v1/geocode/autocomplete`

Autocomplete a partial address

### Parameters

- `params: GeocodeAutocompletePostParams`

  - `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?: number`

    Focus latitude

  - `layer?: string`

    Filter by layer: address, poi, or admin

  - `limit?: number`

    Maximum results (default 10, max 20)

  - `lng?: number`

    Focus longitude

### Returns

- `AutocompleteResult`

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

  - `features: Array<GeocodingFeature>`

    Autocomplete suggestions ordered by relevance

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```typescript
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.autocompletePost({ q: 'q' });

console.log(autocompleteResult.features);
```

#### Response

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

## Batch geocode multiple addresses

`client.geocode.batch(GeocodeBatchParamsbody, RequestOptionsoptions?): GeocodeBatchResponse`

**post** `/api/v1/geocode/batch`

Batch geocode multiple addresses

### Parameters

- `body: GeocodeBatchParams`

  - `addresses: Array<string>`

### Returns

- `GeocodeBatchResponse`

  Batch geocoding result. Each entry in `results` is a FeatureCollection corresponding to the input address at the same index. Order is preserved.

  - `count: number`

    Number of addresses processed (always equals length of results)

  - `results: Array<GeocodeResult>`

    Array of FeatureCollections, one per input address. Empty FeatureCollections indicate no match.

    - `features: Array<GeocodingFeature>`

      Geocoding results ordered by relevance score

      - `geometry: GeoJsonGeometry`

        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.

          - `Array<number>`

          - `Array<Array<number>>`

          - `Array<Array<Array<number>>>`

          - `Array<Array<Array<Array<number>>>>`

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

          Geometry type

          - `"Point"`

          - `"LineString"`

          - `"Polygon"`

          - `"MultiPoint"`

          - `"MultiLineString"`

          - `"MultiPolygon"`

      - `properties: Properties`

        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.

        - `country?: string | null`

          Country name. Present for reverse geocode address results.

        - `country_code?: string | null`

          ISO 3166-1 alpha-2 country code

        - `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)

          - `"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.

        - `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)

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

        - `"Feature"`

    - `type: "FeatureCollection"`

      - `"FeatureCollection"`

### Example

```typescript
import Plaza from '@plazafyi/sdk';

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

const response = await client.geocode.batch({ addresses: ['string'] });

console.log(response.count);
```

#### Response

```json
{
  "count": 0,
  "results": [
    {
      "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"
    }
  ]
}
```

## Domain Types

### Autocomplete Result

- `AutocompleteResult`

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

  - `features: Array<GeocodingFeature>`

    Autocomplete suggestions ordered by relevance

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Geocode Result

- `GeocodeResult`

  GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: `application/geo+json`.

  - `features: Array<GeocodingFeature>`

    Geocoding results ordered by relevance score

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Geocoding Feature

- `GeocodingFeature`

  GeoJSON Feature representing a geocoding result. The geometry is always a Point. Properties include the formatted display name, OSM metadata, confidence score, and source type.

  - `geometry: GeoJsonGeometry`

    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.

      - `Array<number>`

      - `Array<Array<number>>`

      - `Array<Array<Array<number>>>`

      - `Array<Array<Array<Array<number>>>>`

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

      Geometry type

      - `"Point"`

      - `"LineString"`

      - `"Polygon"`

      - `"MultiPoint"`

      - `"MultiLineString"`

      - `"MultiPolygon"`

  - `properties: Properties`

    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.

    - `country?: string | null`

      Country name. Present for reverse geocode address results.

    - `country_code?: string | null`

      ISO 3166-1 alpha-2 country code

    - `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)

      - `"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.

    - `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)

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

    - `"Feature"`

### Reverse Geocode Result

- `ReverseGeocodeResult`

  GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: `application/geo+json`.

  - `features: Array<GeocodingFeature>`

    Reverse geocoding results ordered by distance

    - `geometry: GeoJsonGeometry`

      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.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      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.

      - `country?: string | null`

        Country name. Present for reverse geocode address results.

      - `country_code?: string | null`

        ISO 3166-1 alpha-2 country code

      - `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)

        - `"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.

      - `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)

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

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`