{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"📖 Autocomplete Geocoding API – Parameters Overview","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"-autocomplete-geocoding-api--parameters-overview","__idx":0},"children":["📖 Autocomplete Geocoding API – Parameters Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Autocomplete Geocoding API accepts several parameters that control how partial address lookups are performed and how suggestions are returned.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"They fall into two categories: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["mandatory"]}," (must be present) and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["optional"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-mandatory","__idx":1},"children":["✅ Mandatory"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["place"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The free-text input (postal address, city, POI, etc.) to autocomplete.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"👉 This field is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["always required"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["coordinate"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Defines the center of the search area (latitude & longitude, WGS84).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"⚠️ Most providers require this field for accurate suggestions.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Type: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#coordinate"},"children":["Coordinate"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Language code (ISO 639-1, 2 letters) used for suggestions.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Special value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"IC\""]}," → case-insensitive country code search.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"👉 Must always be provided."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"️-optional","__idx":2},"children":["⚙️ Optional"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boundingBox"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Restrict the autocomplete search to a rectangular area in WGS84 coordinates.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Type: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#boundingbox"},"children":["BoundingBox"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Restrict results to a specific country (ISO 3166 Alpha-2 or Alpha-3 code)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["geoserver"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Name of the geoserver to use.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nominatim"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addok"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["herehlp"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If not defined, the default geoserver will be used."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["radius"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Defines the search radius in meters around the given coordinate. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["long"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addressDetails"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", returns suggestions split into fields (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["street"]},", etc.).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enCategories"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Enables category IDs in the response (primary flagged)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enChains"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Enables chain metadata (e.g., franchise information)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enEntrances"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Returns geo-coordinates of entrances (when available)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enFoodTypes"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Returns food-type IDs (primary flagged)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enHighlights"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Returns text slices matching the query, useful for highlighting."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enLocId"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Specific to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["herehlp"]},": returns Location ID if ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enReferences"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Returns supplier-specific source IDs when available."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-example-overview","__idx":3},"children":["📦 Example (overview)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Paris\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"boundingBox\": {\n    \"minLat\": 48.80,\n    \"minLon\": 2.25,\n    \"maxLat\": 48.95,\n    \"maxLon\": 2.45\n  },\n  \"countryCode\": \"FR\",\n  \"language\": \"fr\",\n  \"radius\": 10000,\n  \"addressDetails\": true,\n  \"enHighlights\": true,\n  \"maximumResults\": 5\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"️-place","__idx":4},"children":["🏷️ place"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provide a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["free-text input"]}," (postal address, city, POI, etc.) to trigger autocomplete suggestions.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This is the starting point of the query — the text the user is typing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service analyzes the string and returns a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["list of possible completions"]},": street names, cities, POIs, depending on the context and provider."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["place"]}," field in the request body with a text string.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"👉 This field is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["mandatory"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"place\": \"Boulevard Sai\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-coordinate","__idx":5},"children":["📍 coordinate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Define the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["center of the search area"]}," to improve the relevance of autocomplete suggestions.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful when the same place name exists in different regions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service prioritizes suggestions that are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["closer to the given coordinate"]}," (latitude, longitude, WGS84).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Some providers require this parameter to work."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  }\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-language","__idx":6},"children":["🌐 language"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Control the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["language of suggestions"]}," returned by the service.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful for multilingual regions or international applications."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the requested language is supported, suggestions are returned in that language.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If not, the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["default language"]}," of the geoserver is used.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Special value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"IC\""]}," → enables case-insensitive search by country codes (ISO-3166 Alpha-2 or Alpha-3)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"language\": \"fr\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-boundingbox","__idx":7},"children":["📐 boundingBox"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Limit the autocomplete search to a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["specific rectangular area"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This avoids irrelevant suggestions coming from other regions when a place name is ambiguous."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service only considers results ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["inside the defined rectangle"]}," (WGS84 coordinates).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful for narrowing down searches to a city, region, or trip corridor."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boundingBox"]}," field in the request body.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"It requires ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["four coordinates"]}," in decimal degrees (WGS84):"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minLat"]}," → minimum latitude"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minLon"]}," → minimum longitude"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxLat"]}," → maximum latitude"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxLon"]}," → maximum longitude"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"boundingBox\": {\n    \"minLat\": 48.80,\n    \"minLon\": 2.25,\n    \"maxLat\": 48.95,\n    \"maxLon\": 2.45\n  }\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"boundingBox\": {\n    \"minLat\": 48.80,\n    \"minLon\": 2.25,\n    \"maxLat\": 48.95,\n    \"maxLon\": 2.45\n  },\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-countrycode","__idx":8},"children":["🌎 countryCode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Restrict the autocomplete results to a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["specific country"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful when the same city or street name exists in multiple countries."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service will only return suggestions that match the given ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ISO country code"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Supported formats:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Alpha-2"]}," (2 letters, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"FR\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"DE\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"US\""]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Alpha-3"]}," (3 letters, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"FRA\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"DEU\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"USA\""]},")"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}," field in the request body with the ISO code of the desired country."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"countryCode\": \"FR\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"countryCode\": \"FR\",\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"️-addressdetails","__idx":9},"children":["🏷️ addressDetails"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["postal address split into separate fields"]}," (country, city, street, postal code, etc.) instead of a single formatted string.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful if your application needs to store or display structured address components."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the response includes a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["detailed object"]}," with fields like ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["street"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]},", etc.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"By default, the service only returns a formatted address string."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addressDetails"]}," field in the request body and set it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"addressDetails\": true\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"addressDetails\": true,\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"️-encategories","__idx":10},"children":["🗂️ enCategories"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["categories"]}," (e.g. restaurant, hotel, park) associated with each autocomplete result.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful for filtering or displaying an icon/type alongside place suggestions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the response contains a list of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["category IDs"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"One category is marked as ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["primary"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"primary\": true"]},") to indicate the most relevant classification."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enCategories"]}," field in the request body and set it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"enCategories\": true\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"enCategories\": true,\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-enchains","__idx":11},"children":["🏬 enChains"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identify whether a place belongs to a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["commercial chain"]}," (e.g. McDonald’s, Carrefour, Starbucks).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful for apps that want to display a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["chain-specific icon"]}," or group results by brand."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the response includes ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["metadata about chains"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This allows clients to recognize and visually highlight places that are part of a well-known chain."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enChains"]}," field in the request body and set it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"enChains\": true\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"enChains\": true,\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"div","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-enentrances","__idx":12},"children":["🚪 enEntrances"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["precise entrances"]}," of a place (e.g. the door of a shopping mall, a parking entry, or a building entrance).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful for navigation apps that need to guide users to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["correct access point"]}," instead of just the building’s center."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the response contains a list of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["geo-coordinates"]}," representing entrances associated with the place.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This helps refine arrival instructions for pedestrians or drivers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enEntrances"]}," field in the request body and set it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"enEntrances\": true\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"enEntrances\": true,\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-enfoodtypes","__idx":13},"children":["🍴 enFoodTypes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["type of cuisine"]}," for restaurants or food-related places (e.g. Italian, Japanese, Fast food).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful for apps that want to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["filter or display food categories"]}," directly in search suggestions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the response includes a list of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["food-type IDs"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"One food type is marked as ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["primary"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"primary\": true"]},") to indicate the most relevant cuisine category."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enFoodTypes"]}," field in the request body and set it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"enFoodTypes\": true\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"enFoodTypes\": true,\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-enhighlights","__idx":14},"children":["✨ enHighlights"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Highlight the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["matching parts of the suggestion text"]}," that correspond to the user’s query.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful for autocomplete UIs where you want to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["bold or emphasize"]}," the part of the result that matches the search."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"When enabled, the response includes ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["text slices"]}," that explicitly show which characters matched the query.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This can be used to visually highlight relevant parts in your application."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enHighlights"]}," field in the request body and set it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"enHighlights\": true\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"enHighlights\": true,\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-enlocid","__idx":15},"children":["🆔 enLocId"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["unique Location ID"]}," provided by the HERE HLP geoserver.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful if your application needs to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["store, reuse, or request updates"]}," for the exact same place later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the response includes a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["location identifier"]}," (LocId) generated by HERE HLP.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This ID is persistent and can be used as a stable reference to the place."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enLocId"]}," field in the request body and set it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"⚠️ Only applies when using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["herehlp"]}," geoserver."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"enLocId\": true\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"herehlp\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"enLocId\": true,\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-enreferences","__idx":16},"children":["🔗 enReferences"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Retrieve the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["data source references"]}," that contributed to a place result.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful if your application needs to display or log the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["origin of the information"]}," (e.g. OpenStreetMap, HERE, other providers)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"When enabled, the response includes a list of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["reference IDs"]}," from external data sources.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This metadata allows you to trace where the place information comes from."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enReferences"]}," field in the request body and set it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Default value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"enReferences\": true\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"enReferences\": true,\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-geoserver","__idx":17},"children":["🌍 geoserver"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Choose which ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["geocoding provider"]}," to use for the autocomplete request.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Different providers may return different results in terms of coverage, accuracy, or available metadata."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The service delegates the autocomplete query to the selected ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["geoserver backend"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If not specified, a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["default provider"]}," is used.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Supported values:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"nominatim\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"addok\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"herehlp\""]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["geoserver"]}," field in the request body with one of the supported provider names."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"maximumResults\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-radius","__idx":18},"children":["📏 radius"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Restrict autocomplete suggestions to a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["circular area around a point"]},", defined by its radius in meters.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Useful when searching for places ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["near a specific location"]}," (e.g. POIs around the user’s position)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service limits the search results to those located ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["within the given distance"]}," from the specified coordinate.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This helps focus results on nearby areas only."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["radius"]}," field in the request body with a value in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["meters"]}," (type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["long"]},").",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"It must be used together with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["coordinate"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"radius\": 1000\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"place\": \"Boulevard Sai\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"language\": \"fr\",\n  \"radius\": 1000,\n  \"maximumResults\": 3\n}\n"},"children":[]}]},"headings":[{"value":"📖 Autocomplete Geocoding API – Parameters Overview","id":"-autocomplete-geocoding-api--parameters-overview","depth":1},{"value":"✅ Mandatory","id":"-mandatory","depth":2},{"value":"⚙️ Optional","id":"️-optional","depth":2},{"value":"📦 Example (overview)","id":"-example-overview","depth":2},{"value":"🏷️ place","id":"️-place","depth":2},{"value":"📍 coordinate","id":"-coordinate","depth":2},{"value":"🌐 language","id":"-language","depth":2},{"value":"📐 boundingBox","id":"-boundingbox","depth":2},{"value":"🌎 countryCode","id":"-countrycode","depth":2},{"value":"🏷️ addressDetails","id":"️-addressdetails","depth":2},{"value":"🗂️ enCategories","id":"️-encategories","depth":2},{"value":"🏬 enChains","id":"-enchains","depth":2},{"value":"🚪 enEntrances","id":"-enentrances","depth":2},{"value":"🍴 enFoodTypes","id":"-enfoodtypes","depth":2},{"value":"✨ enHighlights","id":"-enhighlights","depth":2},{"value":"🆔 enLocId","id":"-enlocid","depth":2},{"value":"🔗 enReferences","id":"-enreferences","depth":2},{"value":"🌍 geoserver","id":"-geoserver","depth":2},{"value":"📏 radius","id":"-radius","depth":2}],"frontmatter":{"seo":{"title":"📖 Autocomplete Geocoding API – Parameters Overview"}},"lastModified":"2025-09-22T11:50:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference/geocoding/tutorial-autocomplete-geocoding/autocomplete_geocoding_parameters","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}