{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"📖 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":"-geocoding-api--parameters-overview","__idx":0},"children":["📖 Geocoding API – Parameters Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Geocoding API accepts several parameters that control how the address lookup is performed and how results are returned.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"They fall into two categories: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["mandatory"]}," (at least one 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":["address"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Defines the postal address to geocode. It can contain fields such as ",{"$$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":[]},"👉 At least ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]},", or alternatively a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boundingBox"]},", must be provided."]}]},{"$$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":[]},"Defines a rectangular area (in WGS84 coordinates) that restricts the search. Useful when the same address exists in multiple regions."]}]}]},{"$$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":["assetSearchType"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Defines the type of object to search for. Possible values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CITY_CENTER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OBJECT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POI"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROAD"]},"."]}]},{"$$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. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["here"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["osm"]},"."]}]},{"$$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) for the address lookup.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Special value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"IC\""]}," → case-insensitive search by country code (ISO-3166 Alpha-2 or Alpha-3)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maximumResults"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Maximum number of results returned by the server. Type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchType"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Controls how the input string is matched. Possible values:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINS"]}," → pattern must be contained in the results."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FUZZY"]}," → fuzzy matching (typos tolerated)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["KEY_SEARCH"]}," → search by unique identifiers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STRICT"]}," → exact match only."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STRICT_BEGINNING"]}," → result must start with the pattern."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WORD_BEGINNING"]}," → one word must begin with the pattern."]}]}]}]},{"$$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\": \"osm\",\n  \"address\": {\n    \"country\": \"France\",\n    \"city\": \"Paris\",\n    \"street\": \"villa des pyrénées\"\n  },\n  \"boundingBox\": {\n    \"minLat\": 48.80,\n    \"minLon\": 2.25,\n    \"maxLat\": 48.90,\n    \"maxLon\": 2.45\n  },\n  \"assetSearchType\": \"POI\",\n  \"searchType\": \"FUZZY\",\n  \"maximumResults\": 3,\n  \"language\": \"fr\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["➡️ This request searches for “Villa des Pyrénées, Paris” within the specified bounding box, returning up to 3 results in French, using fuzzy matching."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-boundingbox","__idx":4},"children":["📐 BoundingBox"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]}," ","Limit the geocoding search to a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["specific area"]}," (e.g. a city or trip corridor), to avoid irrelevant results from other regions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]}," ","The service only returns addresses ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["inside the defined rectangle"]}," (WGS84 coordinates)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]}," ","Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boundingBox"]}," field in the request body with 4 coordinates: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxLat"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxLon"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minLat"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minLon"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"osm\",\n  \"address\": {\n    \"city\": \"Paris\",\n    \"street\": \"rue de la paix\"\n  },\n  \"boundingBox\": {\n    \"maxLat\": 48.95,\n    \"maxLon\": 2.50,\n    \"minLat\": 48.80,\n    \"minLon\": 2.25\n  },\n  \"language\": \"fr\",\n  \"maximumResult\": 3\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📤 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"extent\": {\n    \"minLon\": 2.33029,\n    \"minLat\": 48.86834,\n    \"maxLon\": 2.33227,\n    \"maxLat\": 48.87025\n  },\n  \"elements\": [\n    {\n      \"boundingBox\": {\n        \"minLon\": 2.33029,\n        \"minLat\": 48.86834,\n        \"maxLon\": 2.33227,\n        \"maxLat\": 48.87025\n      },\n      \"coordinate\": {\n        \"lon\": 2.33045,\n        \"lat\": 48.8685\n      },\n      \"distanceFromRequest\": 0,\n      \"postalAddress\": {\n        \"countryCode\": \"FRA\",\n        \"country\": \"France\",\n        \"state\": \"Île-de-France\",\n        \"county\": \"Paris\",\n        \"city\": \"Paris\",\n        \"district\": \"Paris 2e Arrondissement\",\n        \"postalCode\": \"75002\",\n        \"street\": \"Rue de la Paix\"\n      },\n      \"postalAddressClassType\": \"ROAD_TERTIARY\",\n      \"postalAddressClassId\": 4304,\n      \"postalAddressExactStreeNumber\": false,\n      \"angle\": -147,\n      \"administrativeSpeedLimit\": 0,\n      \"relevanceScore\": 1,\n      \"countryRelevanceScore\": 1,\n      \"cityRelevanceScore\": 0.75,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 1,\n      \"streetNumberRelevanceScore\": 0,\n      \"segmentId\": 0\n    }\n  ],\n  \"maximunResult\": 1\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-address","__idx":5},"children":["🏠 Address"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Provide a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["postal address"]}," (country, city, street, etc.) that you want to convert into geographical coordinates."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The service parses the given address fields and returns one or more ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["matching locations"]}," with longitude/latitude coordinates."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["🔧 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to enable"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address"]}," object in the request body.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"You can specify any combination of fields: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["district"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["street"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["streetNumber"]},", etc."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"osm\",\n  \"address\": {\n    \"country\": \"France\",\n    \"city\": \"Paris\",\n    \"street\": \"Rue de Rivoli\",\n    \"streetNumber\": \"99\"\n  },\n  \"language\": \"fr\",\n  \"maximumResult\": 1\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"extent\": {\n    \"minLon\": 2.32341,\n    \"minLat\": 48.85852,\n    \"maxLon\": 2.3482,\n    \"maxLat\": 48.86637\n  },\n  \"elements\": [\n    {\n      \"boundingBox\": {\n        \"minLon\": 2.32341,\n        \"minLat\": 48.85852,\n        \"maxLon\": 2.3482,\n        \"maxLat\": 48.86637\n      },\n      \"coordinate\": {\n        \"lon\": 2.33491,\n        \"lat\": 48.86284\n      },\n      \"exactCoordinate\": {\n        \"lon\": 2.33482,\n        \"lat\": 48.86273\n      },\n      \"distanceFromRequest\": 0,\n      \"postalAddress\": {\n        \"countryCode\": \"FRA\",\n        \"country\": \"France\",\n        \"state\": \"Île-de-France\",\n        \"county\": \"Paris\",\n        \"city\": \"Paris\",\n        \"district\": \"Paris 1er Arrondissement\",\n        \"postalCode\": \"75001\",\n        \"street\": \"Rue de Rivoli\",\n        \"streetNumber\": \"99\"\n      },\n      \"postalAddressClassType\": \"ROAD_TERTIARY\",\n      \"postalAddressClassId\": 4304,\n      \"postalAddressExactStreeNumber\": true,\n      \"angle\": 117,\n      \"administrativeSpeedLimit\": 0,\n      \"relevanceScore\": 1,\n      \"countryRelevanceScore\": 1,\n      \"cityRelevanceScore\": 0.75,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 1,\n      \"streetNumberRelevanceScore\": 1,\n      \"segmentId\": 0\n    }\n  ],\n  \"maximunResult\": 1\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":"br","attributes":{},"children":[]},"Control the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["language"]}," used for address lookup and returned results (street names, city names, etc.)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If the requested language is available, the response will return the address in that language.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If not, the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["default language"]}," of the geoserver will be used.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Special value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"IC\""]}," allows case-insensitive search by ISO country codes."]},{"$$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":["language"]}," field in the request body with an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ISO 639-1"]}," 2-letter code (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fr"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["de"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"osm\",\n  \"address\": {\n    \"country\": \"Germany\",\n    \"city\": \"Munich\",\n    \"street\": \"Marienplatz\"\n  },\n  \"language\": \"de\",\n  \"maximumResult\": 1\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"extent\": {\n    \"minLon\": -73.26347,\n    \"minLat\": 59.77727,\n    \"maxLon\": -11.31233,\n    \"maxLat\": 83.62743\n  },\n  \"elements\": [\n    {\n      \"boundingBox\": {\n        \"minLon\": -73.26347,\n        \"minLat\": 59.77727,\n        \"maxLon\": -11.31233,\n        \"maxLat\": 83.62743\n      },\n      \"coordinate\": {\n        \"lon\": -42.2879,\n        \"lat\": 71.70235\n      },\n      \"distanceFromRequest\": 0,\n      \"postalAddress\": {\n        \"countryCode\": \"GRL\",\n        \"country\": \"Greenland\"\n      },\n      \"postalAddressClassType\": \"COUNTRY\",\n      \"postalAddressClassId\": 1111,\n      \"postalAddressExactStreeNumber\": false,\n      \"angle\": 0,\n      \"administrativeSpeedLimit\": 0,\n      \"relevanceScore\": 0.6,\n      \"countryRelevanceScore\": 0.6,\n      \"cityRelevanceScore\": 1,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 1,\n      \"streetNumberRelevanceScore\": 0,\n      \"segmentId\": 0\n    }\n  ],\n  \"maximunResult\": 1\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-searchtype","__idx":7},"children":["🔍 searchType"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Control the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["matching strategy"]}," used when searching for addresses. Useful to handle typos, partial inputs, or strict searches."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Determines how the service compares the input text with stored addresses:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINS"]}," → match if the input is contained in the address."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FUZZY"]}," → allows typos or misspellings (fuzzy search)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["KEY_SEARCH"]}," → search by key identifiers (IDs)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STRICT"]}," → exact match only."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STRICT_BEGINNING"]}," → match must start with the input string."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WORD_BEGINNING"]}," → match if one word begins with the input (separators: space, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/"]},")."]}]},{"$$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":["searchType"]}," field in the request body with one of the supported values."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"osm\",\n  \"address\": {\n    \"country\": \"France\",\n    \"city\": \"Paris\",\n    \"street\": \"villa des pyrenes\"\n  },\n  \"searchType\": \"FUZZY\",\n  \"maximumResult\": 2,\n  \"language\": \"fr\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"extent\": {\n    \"minLon\": 2.40518,\n    \"minLat\": 48.8533,\n    \"maxLon\": 2.40587,\n    \"maxLat\": 48.85351\n  },\n  \"elements\": [\n    {\n      \"boundingBox\": {\n        \"minLon\": 2.40518,\n        \"minLat\": 48.8533,\n        \"maxLon\": 2.40587,\n        \"maxLat\": 48.85351\n      },\n      \"coordinate\": {\n        \"lon\": 2.40552,\n        \"lat\": 48.85342\n      },\n      \"distanceFromRequest\": 0,\n      \"postalAddress\": {\n        \"countryCode\": \"FRA\",\n        \"country\": \"France\",\n        \"state\": \"Île-de-France\",\n        \"county\": \"Paris\",\n        \"city\": \"Paris\",\n        \"district\": \"Paris 20e Arrondissement\",\n        \"postalCode\": \"75020\",\n        \"street\": \"Villa des Pyrénées\"\n      },\n      \"postalAddressClassType\": \"ROAD_FOURTH\",\n      \"postalAddressClassId\": 4048,\n      \"postalAddressExactStreeNumber\": false,\n      \"angle\": 62,\n      \"administrativeSpeedLimit\": 0,\n      \"relevanceScore\": 0.96,\n      \"countryRelevanceScore\": 1,\n      \"cityRelevanceScore\": 0.75,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 0.96,\n      \"streetNumberRelevanceScore\": 0,\n      \"segmentId\": 0\n    },\n    {\n      \"coordinate\": {\n        \"lon\": 2.33936,\n        \"lat\": 48.85113\n      },\n      \"exactCoordinate\": {\n        \"lon\": 2.33939,\n        \"lat\": 48.85114\n      },\n      \"distanceFromRequest\": 2.46,\n      \"postalAddress\": {\n        \"countryCode\": \"FRA\",\n        \"country\": \"France\",\n        \"state\": \"Île-de-France\",\n        \"county\": \"Paris\",\n        \"city\": \"Paris\",\n        \"district\": \"Paris 6e Arrondissement\",\n        \"postalCode\": \"75006\",\n        \"roadNumber\": \"\",\n        \"street\": \"Villa des Princes, Rue Monsieur le Prince\",\n        \"streetNumber\": \"19\",\n        \"oppositeStreetNumber\": \"10\"\n      },\n      \"postalAddressClassType\": \"HOTEL_MOTEL\",\n      \"postalAddressClassId\": 7314,\n      \"postalAddressExactStreeNumber\": false,\n      \"angle\": -27,\n      \"administrativeSpeedLimit\": 30,\n      \"relevanceScore\": 0.87,\n      \"countryRelevanceScore\": 1,\n      \"cityRelevanceScore\": 0.75,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 0.87,\n      \"streetNumberRelevanceScore\": 0,\n      \"geoElementTypes\": [\n        \"ROAD\",\n        \"FOURTH_ROAD\",\n        \"DISTRICT\",\n        \"CITY\",\n        \"COUNTY\",\n        \"STATE\",\n        \"COUNTRY\"\n      ],\n      \"segmentId\": 0\n    }\n  ],\n  \"maximunResult\": 2\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-maximumresults","__idx":8},"children":["🔢 maximumResults"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Limit the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["number of results"]}," returned by the geocoding request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The service will return ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["at most N addresses"]}," matching the search.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This helps avoid long responses and keeps only the most relevant results."]},{"$$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":["maximumResults"]}," field in the request body with an integer value."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"osm\",\n  \"address\": {\n    \"country\": \"France\",\n    \"city\": \"Paris\",\n    \"street\": \"Rue de Rivoli\"\n  },\n  \"maximumResults\": 3,\n  \"language\": \"fr\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"extent\": {\n    \"minLon\": 2.32341,\n    \"minLat\": 48.85504,\n    \"maxLon\": 2.36171,\n    \"maxLat\": 48.86637\n  },\n  \"elements\": [\n    {\n      \"boundingBox\": {\n        \"minLon\": 2.32341,\n        \"minLat\": 48.85852,\n        \"maxLon\": 2.3482,\n        \"maxLat\": 48.86637\n      },\n      \"coordinate\": {\n        \"lon\": 2.3482,\n        \"lat\": 48.85852\n      },\n      \"distanceFromRequest\": 0,\n      \"postalAddress\": {\n        \"countryCode\": \"FRA\",\n        \"country\": \"France\",\n        \"state\": \"Île-de-France\",\n        \"county\": \"Paris\",\n        \"city\": \"Paris\",\n        \"district\": \"Paris 1er Arrondissement\",\n        \"postalCode\": \"75001\",\n        \"street\": \"Rue de Rivoli\"\n      },\n      \"postalAddressClassType\": \"ROAD_TERTIARY\",\n      \"postalAddressClassId\": 4304,\n      \"postalAddressExactStreeNumber\": false,\n      \"angle\": 117,\n      \"administrativeSpeedLimit\": 0,\n      \"relevanceScore\": 1,\n      \"countryRelevanceScore\": 1,\n      \"cityRelevanceScore\": 0.75,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 1,\n      \"streetNumberRelevanceScore\": 0,\n      \"segmentId\": 0\n    },\n    {\n      \"boundingBox\": {\n        \"minLon\": 2.3482,\n        \"minLat\": 48.85504,\n        \"maxLon\": 2.36171,\n        \"maxLat\": 48.85852\n      },\n      \"coordinate\": {\n        \"lon\": 2.35931,\n        \"lat\": 48.85562\n      },\n      \"distanceFromRequest\": 0,\n      \"postalAddress\": {\n        \"countryCode\": \"FRA\",\n        \"country\": \"France\",\n        \"state\": \"Île-de-France\",\n        \"county\": \"Paris\",\n        \"city\": \"Paris\",\n        \"district\": \"Paris 4e Arrondissement\",\n        \"postalCode\": \"75004\",\n        \"street\": \"Rue de Rivoli\"\n      },\n      \"postalAddressClassType\": \"ROAD_FOURTH\",\n      \"postalAddressClassId\": 4048,\n      \"postalAddressExactStreeNumber\": false,\n      \"angle\": 110,\n      \"administrativeSpeedLimit\": 0,\n      \"relevanceScore\": 1,\n      \"countryRelevanceScore\": 1,\n      \"cityRelevanceScore\": 0.75,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 1,\n      \"streetNumberRelevanceScore\": 0,\n      \"segmentId\": 0\n    }\n  ],\n  \"maximunResult\": 2\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"️-assetsearchtype","__idx":9},"children":["🏷️ assetSearchType"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Refine the geocoding search to target a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["specific type of asset"]}," (e.g. city center, road, POI)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The service adjusts the results depending on the selected asset type:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CITY_CENTER"]}," → returns the central point of a city."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OBJECT"]}," → returns generic objects (buildings, addresses)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POI"]}," → returns points of interest (restaurants, landmarks, etc.)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROAD"]}," → returns road segments or streets."]}]},{"$$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":["assetSearchType"]}," field in the request body with one of the available values."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"osm\",\n  \"address\": {\n    \"country\": \"France\",\n    \"city\": \"Nice\"\n  },\n  \"assetSearchType\": \"CITY_CENTER\",\n  \"maximumResults\": 1,\n  \"language\": \"fr\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"extent\": {\n    \"minLon\": 7.18193,\n    \"minLat\": 43.64566,\n    \"maxLon\": 7.32309,\n    \"maxLat\": 43.76084\n  },\n  \"elements\": [\n    {\n      \"boundingBox\": {\n        \"minLon\": 7.18193,\n        \"minLat\": 43.64566,\n        \"maxLon\": 7.32309,\n        \"maxLat\": 43.76084\n      },\n      \"coordinate\": {\n        \"lon\": 7.27768,\n        \"lat\": 43.70032\n      },\n      \"distanceFromRequest\": 0,\n      \"postalAddress\": {\n        \"countryCode\": \"FRA\",\n        \"country\": \"France\",\n        \"state\": \"Provence-Alpes-Côte d'Azur\",\n        \"county\": \"Alpes-Maritimes\",\n        \"city\": \"Nice\"\n      },\n      \"postalAddressClassType\": \"ORDRE_8_AREA\",\n      \"postalAddressClassId\": 1119,\n      \"postalAddressExactStreeNumber\": false,\n      \"angle\": 0,\n      \"administrativeSpeedLimit\": 0,\n      \"relevanceScore\": 1,\n      \"countryRelevanceScore\": 1,\n      \"cityRelevanceScore\": 1,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 1,\n      \"streetNumberRelevanceScore\": 0,\n      \"segmentId\": 0\n    }\n  ],\n  \"maximunResult\": 1\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-geoserver","__idx":10},"children":["🌍 geoserver"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use case"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["geographical database"]}," (geoserver) to be used for the geocoding request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What it does"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The service queries the chosen geoserver (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["here"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["osm"]},") to return coordinates for the provided address.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Different geoservers may give ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["different results"]}," depending on their coverage and data quality."]},{"$$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 the desired geoserver name as a string."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📦 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"geoserver\": \"osm\",\n  \"address\": {\n    \"country\": \"Italy\",\n    \"city\": \"Rome\",\n    \"street\": \"Via del Corso\"\n  },\n  \"geoserver\": \"osm\",\n  \"maximumResults\": 1,\n  \"language\": \"en\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"extent\": {\n    \"minLon\": 12.47651,\n    \"minLat\": 41.89668,\n    \"maxLon\": 12.48222,\n    \"maxLat\": 41.91031\n  },\n  \"elements\": [\n    {\n      \"boundingBox\": {\n        \"minLon\": 12.47651,\n        \"minLat\": 41.89668,\n        \"maxLon\": 12.48222,\n        \"maxLat\": 41.91031\n      },\n      \"coordinate\": {\n        \"lon\": 12.47675,\n        \"lat\": 41.90975\n      },\n      \"distanceFromRequest\": 0,\n      \"postalAddress\": {\n        \"countryCode\": \"ITA\",\n        \"country\": \"Italy\",\n        \"state\": \"Lazio\",\n        \"county\": \"Roma\",\n        \"city\": \"Rome\",\n        \"district\": \"Municipio Roma I\",\n        \"street\": \"Via del Corso\"\n      },\n      \"postalAddressClassType\": \"ROAD_FOURTH_PEDESTRIAN\",\n      \"postalAddressClassId\": 4000,\n      \"postalAddressExactStreeNumber\": false,\n      \"angle\": 0,\n      \"administrativeSpeedLimit\": 0,\n      \"relevanceScore\": 1,\n      \"countryRelevanceScore\": 1,\n      \"cityRelevanceScore\": 0.4,\n      \"postalCodeRelevanceScore\": 1,\n      \"streetRelevanceScore\": 1,\n      \"streetNumberRelevanceScore\": 0,\n      \"segmentId\": 0\n    }\n  ],\n  \"maximunResult\": 1\n}\n"},"children":[]}]},"headings":[{"value":"📖 Geocoding API – Parameters Overview","id":"-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":"📐 BoundingBox","id":"-boundingbox","depth":2},{"value":"🏠 Address","id":"-address","depth":2},{"value":"🌐 Language","id":"-language","depth":2},{"value":"🔍 searchType","id":"-searchtype","depth":2},{"value":"🔢 maximumResults","id":"-maximumresults","depth":2},{"value":"🏷️ assetSearchType","id":"️-assetsearchtype","depth":2},{"value":"🌍 geoserver","id":"-geoserver","depth":2}],"frontmatter":{"seo":{"title":"📖 Geocoding API – Parameters Overview"}},"lastModified":"2025-09-25T07:10:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference/geocoding/tutorial-geocoding/geocoding_parameters","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}