Infer Italy
AlphaSuggest possible Italian addresses from a string.
https://api.pro6pp.nl/v2/infer/itOverview
Official German and Slovene settlement names match canonical Italian source addresses.
Resolves a single query string into complete or probable addresses and returns a list of ranked suggestions.
Each suggestion includes a stage indicating the current resolution step or completion status.
Stage meanings:
empty: returned on an empty query.mixed: settlement and street suggestions.postcode: postal code suggestions.street_number: street number suggestions.addition: street number addition suggestions.direct: full address suggestions, with or without an addition.final: a fully validated and structured address.
Street and settlement name matching:
- One or two characters match names from the start (prefix).
- Three or more characters match anywhere in the name:
gebouwalso findsKlokgebouw. - Matches are ranked by quality: the exact name first, then names the query starts, then matches beginning at a word boundary, then mid-word matches. Ties within a rank go to the name covering the most addresses.
- When the names containing the query leave suggestion slots free, close matches fill them below the exact matches, absorbing typos.
ParametersQuery string
String to generate suggestions from.
- Example
Roma, Via Giovanni Giolitti, 101
Maximum number of suggestions to return. Must be between 1 and 1000 when provided; omitting the parameter uses the default page size.
- Min
1- Max
1000
Sort mixed city and street suggestions by relevance (default) or distance.
Distance sorting requires the Infer Extended (infer::location) capability.
Distance sorting uses lat and lng when provided. Otherwise, it uses the
approximate location derived from the request IP. If that location is
unavailable, suggestions are sorted by relevance.
- Default
"relevance"- One of
relevancedistance
Latitude of the origin used for distance sorting. When providing coordinates,
include both lat and lng.
- Min
-90- Max
90
Longitude of the origin used for distance sorting. When providing coordinates,
include both lat and lng.
- Min
-180- Max
180
Responses
| Field | Type | Description |
|---|---|---|
| cities | array of objectNullable | Settlements matching the query, returned only in the mixed stage when any match. |
| cities[].label | string | The settlement name. |
| cities[].exact | boolean | False for a fuzzy match; left out for an exact one |
| cities[].matched_value | string | The value a fuzzy match found, in lowercase |
| cities[].diff_positions | array of integer | The 0-based positions in the query that differ from the fuzzy match |
| stage | string | The current stage of address inference |
| streets | array of objectNullable | Streets matching the query, returned only in the mixed stage when any match. |
| streets[].label | string | The street name. |
| streets[].subtitle | string | The settlement the street lies in, with its postal code when it has one |
| streets[].count | stringNullable | How many settlements ("3 places") or postal codes ("2 postcodes") the street name occurs in, when more than one. |
| streets[].exact | boolean | False for a fuzzy match; left out for an exact one |
| streets[].matched_value | string | The value a fuzzy match found, in lowercase |
| streets[].diff_positions | array of integer | The 0-based positions in the query that differ from the fuzzy match |
| suggestions | array of object | Suggestions for the next part of the address; in the mixed stage, the matching settlements and streets in ranked order. |
| suggestions[].label | string | Human-readable label for the suggestion |
| suggestions[].subtitle | stringNullable | Additional context information |
| suggestions[].count | stringNullable | Number of results for this suggestion |
| suggestions[].value | string | object | Canonical selection string or structured address data for address-detail suggestions. |
| suggestions[].exact | boolean | False for a fuzzy match; left out for an exact one |
| suggestions[].matched_value | string | The value a fuzzy match found, in lowercase |
| suggestions[].diff_positions | array of integer | The 0-based positions in the query that differ from the fuzzy match |
{
"stage": "final",
"suggestions": [
{
"label": "Via Giovanni Giolitti, 101, 00185, Roma",
"value": {
"street": "Via Giovanni Giolitti",
"street_number": "101",
"addition": null,
"postcode": "00185",
"city": "Roma",
"lat": 41.89945,
"lng": 12.50189
}
}
]
}Errors
Fields of an error response
| Field | Type | Description |
|---|---|---|
| error_id | string | The reason the request failed, such as |
| errors | array of object | One entry per problem found in the request. |
| errors[].message | string | A readable explanation of the problem, in English. |
| errors[].help | string | A link to the documentation section that covers the problem. |
| errors[].parameter | any | The parameter the problem is about. Usually its name; a list when several parameters are involved, or a name with the values to choose from when the request must select one. |
| errors[].value | any | The value the request sent for |
MISSING_PARAMETERA parameter that other parameters depend on is missing. errors has one entry per missing parameter.
A parameter that other parameters depend on is missing. errors has one entry per missing parameter.
{
"error_id": "MISSING_PARAMETER",
"errors": [
{
"message": "Required parameter lat is missing",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": "lat"
}
]
}INVALID_PARAMETER_TYPEA value has the wrong type, such as text for a number.
A value has the wrong type, such as text for a number.
{
"error_id": "INVALID_PARAMETER_TYPE",
"errors": [
{
"message": "parameter: lat has invalid 1,0, should be number",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": "lat"
}
]
}INVALID_VALUEA required parameter is missing, or a value is malformed, out of bounds or cannot be found.
A required parameter is missing, or a value is malformed, out of bounds or cannot be found.
{
"error_id": "INVALID_VALUE",
"errors": [
{
"message": "value is invalid",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": "postalCode",
"value": "invalid"
}
]
}UNAUTHORIZEDThe API key is missing, unknown, revoked or expired, its subscription is not active, the request does not match the key's allowlist, or the subscription does not include this call.
The API key is missing, unknown, revoked or expired, its subscription is not active, the request does not match the key's allowlist, or the subscription does not include this call.
{
"error_id": "UNAUTHORIZED",
"errors": [
{
"message": "No authorization token provided",
"help": "https://pro6pp.nl/docs/v2/redoc#section/Authentication"
}
]
}Code examples
curl "https://api.pro6pp.nl/v2/infer/it?query=Roma%2C+Via+Giovanni+Giolitti%2C+101&authKey=YOUR_API_KEY"We encourage you to request example code in the language you prefer.
Step by step
Set up a quick form to try out the Italy Infer functionality by following the steps below.
Build the HTML page
We start by creating an empty HTML page, containing a minimal web page structure. Create a new
.htmlfile namedpro6pp_italy_infer.html. Add the following code between the<body>and</body>tags. It adds the input fields for entering the address.<form class="form" id="form"> <div>Call</div> <div> <label for="query">query:</label> <input id="query" class="query" placeholder="Roma, Via Giovanni Giolitti, 101"/> <label for="limit">limit:</label> <input id="limit" class="limit" placeholder=""/> <label for="sort">sort:</label> <input id="sort" class="sort" placeholder=""/> <label for="lat">lat:</label> <input id="lat" class="lat" placeholder=""/> <label for="lng">lng:</label> <input id="lng" class="lng" placeholder=""/> </div> <div> <span style="color: red" class="message"></span> </div> <div> <button type="submit">Submit</button> </div> <br /> <div>Response</div> <br /> <div>Full Response</div> <pre class="jsonResponse"></pre> </form>Add interaction
Add the following JavaScript code in a separate
pro6pp_italy_infer.jsfile. The IDs and Class names of the HTML elements should match with the ones specified in this JavaScript file in order to get the correct results.document.addEventListener("DOMContentLoaded", function() { const pro6ppAuthKey = "AUTH_KEY"; // Replace with your actual authorization key let messageSpan = document.querySelector(".message"); let jsonResponseSpan = document.querySelector(".jsonResponse"); const BASE_URL = "https://api.pro6pp.nl/v2"; function fetchAddress(authKey) { const queryParams = { query: document.getElementById("query").value, authKey: authKey }; const optionalQueryParams = [ "limit", "sort", "lat", "lng", ]; for (const name of optionalQueryParams) { const value = document.getElementById(name).value; if (value !== "") { queryParams[name] = value; } } let encodedUrl = new URL(`${BASE_URL}/infer/it`); encodedUrl.search = new URLSearchParams(queryParams); fetch(encodedUrl) .then(async (response) => { const data = await response.json(); if (data) { messageSpan.textContent = ""; jsonResponseSpan.textContent = JSON.stringify(data, null, 2); } }) .catch((error) => { console.error("Error fetching: ", error); messageSpan.textContent = error.message; }); } const form = document.getElementById("form"); form.onsubmit = function (event) { event.preventDefault(); fetchAddress(pro6ppAuthKey); } });Make it work
Link the JavaScript file inside the
pro6pp_italy_infer.htmlright before closing the</body>tag.... <script src="pro6pp_italy_infer.js"></script> </body> </html>To access the Pro6PP web service, you need to request your personal authorization key. This key is emailed to you right after signing up. Replace the above placeholder
AUTH_KEYwith your personal authorization key.If you don’t have an account yet, sign up for a free 2-month trial. After creating your account, go to your Subscription details and copy your
AUTH_KEY. You’ll need this key to authenticate your requests.See it in action
Once you’ve completed the previous steps, it’s time to run the form locally in your browser. You should now have two files in the same folder on your computer:
pro6pp_italy_infer.html- the HTML page with the form.pro6pp_italy_infer.js- the JavaScript file that handles the interaction.
You can now open the HTML file in your browser by simply double-clicking it in your file explorer (e.g., Finder on macOS or File Explorer on Windows). Alternatively, you can open it manually in the browser using the full
file:///path. For example:file:///C:/Users/YourName/Documents/pro6pp_italy_infer.html file:///Users/yourname/Desktop/pro6pp_italy_infer.htmlOnce the page opens, start typing in the form fields and hit Submit to see the API response displayed in the “Full Response” section.