Infer Austria

Alpha

Suggest possible Austrian addresses from a string.

GEThttps://api.pro6pp.nl/v2/infer/at

Overview

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: gebouw also finds Klokgebouw.
  • 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

authKeystringRequired

Every request needs an API key, which you can get in the portal.

When you call the API from a browser, visitors can see your API key. Limit it to your own domains in the portal, or send the requests through your own server so the key stays hidden.

querystringRequired

String to generate suggestions from.

Example
Innere Stadt, Babenberger
limitinteger

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
sortstring

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
latnumber

Latitude of the origin used for distance sorting. When providing coordinates, include both lat and lng.

Min
-90
Max
90
lngnumber

Longitude of the origin used for distance sorting. When providing coordinates, include both lat and lng.

Min
-180
Max
180

Responses

200Address suggestions for the query
FieldTypeDescription
citiesarray of objectNullable

Settlements matching the query, returned only in the mixed stage when any match.

cities[].labelstring

The settlement name.

cities[].exactboolean

False for a fuzzy match; left out for an exact one

cities[].matched_valuestring

The value a fuzzy match found, in lowercase

cities[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

stagestring

The current stage of address inference

streetsarray of objectNullable

Streets matching the query, returned only in the mixed stage when any match.

streets[].labelstring

The street name.

streets[].subtitlestring

The settlement the street lies in, with its postal code when it has one

streets[].countstringNullable

How many settlements ("3 places") or postal codes ("2 postcodes") the street name occurs in, when more than one.

streets[].exactboolean

False for a fuzzy match; left out for an exact one

streets[].matched_valuestring

The value a fuzzy match found, in lowercase

streets[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

suggestionsarray of object

Suggestions for the next part of the address; in the mixed stage, the matching settlements and streets in ranked order.

suggestions[].labelstring

Human-readable label for the suggestion

suggestions[].subtitlestringNullable

Additional context information (e.g., postal code)

suggestions[].countstringNullable

Number of results for this suggestion (e.g., "2 postcodes")

suggestions[].valuestring | object

Canonical selection string or structured address data for address-detail suggestions.

suggestions[].exactboolean

False for a fuzzy match; left out for an exact one

suggestions[].matched_valuestring

The value a fuzzy match found, in lowercase

suggestions[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

Example response
{
  "stage": "street",
  "suggestions": [
    {
      "label": "Babenbergerpassage",
      "subtitle": "1010"
    },
    {
      "label": "Babenbergerstraße",
      "subtitle": "1010"
    }
  ]
}

Errors

Fields of an error response
FieldTypeDescription
error_idstring

The reason the request failed, such as INVALID_VALUE. The response lists the reasons this operation returns.

errorsarray of object

One entry per problem found in the request.

errors[].messagestring

A readable explanation of the problem, in English.

errors[].helpstring

A link to the documentation section that covers the problem.

errors[].parameterany

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[].valueany

The value the request sent for parameter, when it has one.

400Bad request
MISSING_PARAMETER

A parameter that other parameters depend on is missing. errors has one entry per missing parameter.

MISSING_PARAMETER
{
  "error_id": "MISSING_PARAMETER",
  "errors": [
    {
      "message": "Required parameter lat is missing",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "lat"
    }
  ]
}
INVALID_PARAMETER_TYPE

A value has the wrong type, such as text for a number.

INVALID_PARAMETER_TYPE
{
  "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_VALUE

A required parameter is missing, or a value is malformed, out of bounds or cannot be found.

INVALID_VALUE
{
  "error_id": "INVALID_VALUE",
  "errors": [
    {
      "message": "value is invalid",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "postalCode",
      "value": "invalid"
    }
  ]
}
401Unauthorized
UNAUTHORIZED

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.

UNAUTHORIZED
{
  "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/at?query=Innere+Stadt%2C+Babenberger&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 Austria Infer functionality by following the steps below.

  1. Build the HTML page

    We start by creating an empty HTML page, containing a minimal web page structure. Create a new .html file named pro6pp_austria_infer.html. Add the following code between the <body> and </body> tags. It adds the input fields for entering the address.

    pro6pp_austria_infer.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="query">query:</label>
        <input id="query" class="query" placeholder="Innere Stadt, Babenberger"/>
        <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>
  2. Add interaction

    Add the following JavaScript code in a separate pro6pp_austria_infer.js file. 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.

    pro6pp_austria_infer.js
    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/at`);
            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);
        }
    });
  3. Make it work

    Link the JavaScript file inside the pro6pp_austria_infer.html right before closing the </body> tag.

    pro6pp_austria_infer.html
      ...
      <script src="pro6pp_austria_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_KEY with 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.

  4. 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_austria_infer.html - the HTML page with the form.
    • pro6pp_austria_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:

    Example file paths
    file:///C:/Users/YourName/Documents/pro6pp_austria_infer.html
    file:///Users/yourname/Desktop/pro6pp_austria_infer.html

    Once the page opens, start typing in the form fields and hit Submit to see the API response displayed in the “Full Response” section.