{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"✨ Autocomplete Geocoding API","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","__idx":0},"children":["✨ Autocomplete Geocoding API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Autocomplete Geocoding"]}," service suggests ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["postal addresses"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["places"]}," based on a partial textual input (free text).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"It helps users type faster by offering relevant ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["auto-complete suggestions"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ℹ️ For more details, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/Address"},"children":["Wikipedia"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-endpoint","__idx":1},"children":["🔗 Endpoint"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/bgis/service/geocoding/autocomplete/1.0"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content-Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-sample-request-body","__idx":2},"children":["📦 Sample Request Body"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"nominatim\",\n  \"coordinate\": {\n    \"lat\": 48.8566,\n    \"lon\": 2.3522\n  },\n  \"place\": \"Paris\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📍 All coordinates are defined in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["WGS84"]}," (longitude, latitude). See the coordinate system glossary"," ","for more details."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-parameters","__idx":3},"children":["🔧 Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["⚠️ The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["geoserver"]}," parameter must be one of: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nominatim"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addok"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["herehlp"]},"."," ","If not provided, the default geoserver will be used."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["place"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Textual postal address or POI name to autocomplete. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["coordinate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Center of the search area. Some providers require this parameter. Type: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#coordinate"},"children":["Coordinate"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines the language of the lookup (ISO 639-1 code). ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"IC\""]}," allows case-insensitive search by ISO country codes. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addressDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", returns proposed addresses split into fields (country, city, street, etc.). Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},". Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boundingBox"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Restrict the autocomplete search to a defined rectangle. Type: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#boundingbox"},"children":["BoundingBox"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Restrict results to a specific country code. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enCategories"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return a list of category IDs (with primary flagged). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enChains"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return metadata about place chains (e.g., franchises). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enEntrances"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return geo-coordinates of entrances when available. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enFoodTypes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return available food-type IDs (with primary flagged). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enHighlights"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return text slices matching the query, useful for highlighting results. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enLocId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specific to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["herehlp"]},": return Location ID if ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},". Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enReferences"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return supplier-specific data source IDs when available. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["geoserver"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Geoserver name. Supported values: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nominatim"]}," → OpenStreetMap-based search ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addok"]}," → French ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Base Adresse Nationale (BAN)"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["herehlp"]}," → HERE Hybrid Location Platform. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["radius"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search radius in meters. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["long"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-boundingbox","__idx":4},"children":["📐 BoundingBox"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxLat"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum latitude (WGS84, decimal degrees). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["double"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxLon"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum longitude (WGS84, decimal degrees). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["double"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minLat"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Minimum latitude (WGS84, decimal degrees). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["double"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minLon"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Minimum longitude (WGS84, decimal degrees). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["double"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-coordinate","__idx":5},"children":["📍 Coordinate"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lat"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Latitude (WGS84, decimal degrees). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["double"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lon"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Longitude (WGS84, decimal degrees). Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["double"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-sample-response","__idx":6},"children":["📤 Sample Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"results\": [\n    {\n      \"address\": {\n        \"country\": \"France\",\n        \"city\": \"Paris\",\n        \"street\": \"Boulevard de Sébastopol\"\n      },\n      \"highlight\": \"Boulevard de Sébastopol, Paris\",\n      \"location\": {\n        \"lon\": 2.3522,\n        \"lat\": 48.859\n      }\n    },\n    {\n      \"address\": {\n        \"country\": \"France\",\n        \"city\": \"Paris\",\n        \"street\": \"Boulevard Saint-Germain\"\n      },\n      \"highlight\": \"Boulevard Saint-Germain, Paris\",\n      \"location\": {\n        \"lon\": 2.3505,\n        \"lat\": 48.853\n      }\n    }\n  ]\n}\n"},"children":[]}]},"headings":[{"value":"✨ Autocomplete Geocoding API","id":"-autocomplete-geocoding-api","depth":1},{"value":"🔗 Endpoint","id":"-endpoint","depth":2},{"value":"📦 Sample Request Body","id":"-sample-request-body","depth":2},{"value":"🔧 Parameters","id":"-parameters","depth":2},{"value":"📐 BoundingBox","id":"-boundingbox","depth":2},{"value":"📍 Coordinate","id":"-coordinate","depth":2},{"value":"📤 Sample Response","id":"-sample-response","depth":2}],"frontmatter":{"seo":{"title":"✨ Autocomplete Geocoding API"}},"lastModified":"2025-09-22T11:50:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference/geocoding/autocomplete_geocoding","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}