---
title: "GeocodingFeature | Client js | Api client"
description: "Documentation for MapTiler Client"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Type Alias GeocodingFeature

GeocodingFeature: Feature<Geometry, FeatureProperties\> & FeatureBase & {  
    address?: string;  
    bbox: BBox;  
    center: [Coordinates](https://docs.maptiler.com/client-js/api/types/services_geocoding.Coordinates/);  
    context?: [FeatureHierarchy](https://docs.maptiler.com/client-js/api/types/services_geocoding.FeatureHierarchy/)\[\];  
    matching\_place\_name?: string;  
    matching\_text?: string;  
    place\_name: string;  
    place\_type: [GeocodingPlaceType](https://docs.maptiler.com/client-js/api/types/services_geocoding.GeocodingPlaceType/)\[\];  
    place\_type\_name: string\[\];  
    relevance: number;  
    \[key: \`place\_name\_${string}\`\]: string;  
}

#### Type Declaration

-   ##### \[key: \`place\_name\_${string}\`\]: string
    
    A string analogous to the `place_name` field that matches the query in the requested language. This field is only returned when multiple languages are requested using the `language` parameter, and will be present for each requested language.
    
-   ##### `Optional`address?: string
    
    Address number, if applicable
    
-   ##### bbox: BBox
    
    Bounding box of the original feature as \[w, s, e, n\] array
    
-   ##### center: [Coordinates](https://docs.maptiler.com/client-js/api/types/services_geocoding.Coordinates/)
    
    A \[lon, lat\] array of the original feature centeroid
    
-   ##### `Optional`context?: [FeatureHierarchy](https://docs.maptiler.com/client-js/api/types/services_geocoding.FeatureHierarchy/)\[\]
    
    Feature hierarchy
    
-   ##### `Optional`matching\_place\_name?: string
    
    A string analogous to the `place_name` field that more closely matches the query than results in the specified language. For example, querying _Praha, Czechia_ with language set to English (`en`) might return a feature with the `place_name` _Prague, Czechia_ and a `matching_place_name` of _Praha, Czechia_.
    
-   ##### `Optional`matching\_text?: string
    
    A string analogous to the `text` field that more closely matches the query than results in the specified language. For example, querying _Praha, Czechia_ with language set to English (`en`) might return a feature with the `text` _Prague_ and the `matching_text` _Praha_.
    
-   ##### place\_name: string
    
    Formatted (including the hierarchy) and localized feature full name
    
-   ##### place\_type: [GeocodingPlaceType](https://docs.maptiler.com/client-js/api/types/services_geocoding.GeocodingPlaceType/)\[\]
    
    An array of feature types describing the feature. Currently each feature has only single type but this may change in the future.
    
-   ##### place\_type\_name: string\[\]
    
    Localized type of the place name, matches `place_type` property
    
-   ##### relevance: number
    
    Indicates how well the returned feature matches the user's query on a scale from 0 to 1. 0 means the result does not match the query text at all, while 1 means the result fully matches the query text. You can use the relevance property to remove results that don't fully match the query.
    

-   Defined in [services/geocoding.ts:183](https://github.com/maptiler/maptiler-client-js/blob/f88659ae276c959a754e4c0f3b5c2aae1f483caa/src/services/geocoding.ts#L183)
