Reverse weltweit

Beta

Umkehrung eines Breiten-/Längengrads in eine Adresse.

OpenAPI-Referenz
GEThttps://api.pro6pp.nl/v2/reverse/global

Übersicht

Returns the address at a lat/lng coordinate.

The country is resolved from the coordinate, so the administrative fields in the response are the ones that country publishes. The response schema lists them per country, and the examples show a street and a street-number result for each.

Note: the GB country code denotes the United Kingdom (ISO 3166-1 GB). Address data coverage is currently limited to England; Scotland, Wales and Northern Ireland are not yet included and will be added as coverage expands.

ParameterQuery-String

authKeystringErforderlich

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.

latnumberErforderlich

The latitude.

Beispiel
52.36691
lngnumberErforderlich

The longitude.

Beispiel
4.89489
precisionstring

The precision to search either street or streetnumber

Beispiel
street
Werte
streetstreetnumber

Antworten

200Address found
FeldTypBeispielwertBeschreibung
countrystring"Netherlands"

English name of the country: "Netherlands".

latnumber53.21358

Latitude of the address found, or of a central point of the street at street precision, in WGS84 decimal degrees rounded to five decimals.

lngnumber6.56172

Longitude of the address found, or of a central point of the street at street precision, in WGS84 decimal degrees rounded to five decimals.

municipalitystring"Groningen"

The municipality (gemeente) the result lies in.

postcodesarray of string["9711AA"]

At street precision every postal code on the street, sorted; at streetnumber precision the postal code of the address found.

provincestring"Groningen"

The province (provincie) the result lies in.

settlementstring"Groningen"

The BAG place of residence (woonplaats) the result lies in.

streetstring"Praediniussingel"

The name of the street found.

streetnumberstring"1"

House number of the address found with its premise appended, such as "4A"; present only at streetnumber precision.

Beispielhafte Antwort
{
  "country": "Netherlands",
  "lat": 53.21358,
  "lng": 6.56172,
  "municipality": "Groningen",
  "postcodes": [
    "9711AA"
  ],
  "province": "Groningen",
  "settlement": "Groningen",
  "street": "Praediniussingel",
  "streetnumber": "1"
}

Fehler

Felder einer Fehlerantwort
FeldTypBeschreibung
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.

400Ungültige Anfrage
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"
    }
  ]
}
401Nicht autorisiert
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"
    }
  ]
}
BAD_SUBSCRIPTION_TYPE

The coordinates lie in a country the subscription does not include.

BAD_SUBSCRIPTION_TYPE
{
  "error_id": "BAD_SUBSCRIPTION_TYPE",
  "errors": [
    {
      "message": "['LU', 'FR'] reverse API calls are not available for this subscription type. Please upgrade your subscription to add extra country support.",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2.reverse.worldwide.api.handler"
    }
  ]
}
OUTSIDE_SERVICE_AREA

The coordinates lie outside every supported country.

OUTSIDE_SERVICE_AREA
{
  "error_id": "OUTSIDE_SERVICE_AREA",
  "errors": [
    {
      "message": "This lat/lng combination is outside of our service area",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2.reverse.worldwide.api.handler"
    }
  ]
}
404Kein Ergebnis
NO_RESULTS_FOUND

No result matches the parameters the request sent.

NO_RESULTS_FOUND
{
  "error_id": "NO_RESULTS_FOUND",
  "errors": [
    {
      "message": "No results found",
      "help": "https://pro6pp.nl/docs/v2/redoc"
    }
  ]
}

Codebeispiele

curl "https://api.pro6pp.nl/v2/reverse/global?lat=52.36691&lng=4.89489&authKey=YOUR_API_KEY"

Wir ermutigen Sie, Beispielcode in der von Ihnen bevorzugten Sprache anzufordern.

Schritt für Schritt

Richten Sie ein Schnellformular ein, um die weltweit Reverse-Funktionalität auszuprobieren, indem Sie die folgenden Schritte ausführen.

  1. Erstellen der HTML-Seite

    Wir beginnen mit der Erstellung einer leeren HTML-Seite, die eine minimale Webseitenstruktur enthält. Erstellen Sie eine neue Datei .html mit dem Namen pro6pp_weltweit_reverse.html. Fügen Sie den folgenden Code zwischen den Tags <body> und </body> hinzu. Es fügt die Eingabefelder für die Adresseingabe hinzu.

    pro6pp_weltweit_reverse.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="lat">lat:</label>
        <input id="lat" class="lat" placeholder="52.36691"/>
        <label for="lng">lng:</label>
        <input id="lng" class="lng" placeholder="4.89489"/>
        <label for="precision">precision:</label>
        <input id="precision" class="precision" 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. Interaktion hinzufügen

    Fügen Sie den folgenden JavaScript-Code in eine separate pro6pp_weltweit_reverse.js-Datei ein. Die IDs und Klassennamen der HTML-Elemente sollten mit den in dieser JavaScript-Datei angegebenen übereinstimmen, um die richtigen Ergebnisse zu erhalten.

    pro6pp_weltweit_reverse.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 = {
                lat: document.getElementById("lat").value,
                lng: document.getElementById("lng").value,
                authKey: authKey
            };
            const optionalQueryParams = [
                "precision",
            ];
            for (const name of optionalQueryParams) {
                const value = document.getElementById(name).value;
                if (value !== "") {
                    queryParams[name] = value;
                }
            }
    
            let encodedUrl = new URL(`${BASE_URL}/reverse/global`);
            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. Umsetzung in die Praxis

    Verknüpfen Sie die JavaScript-Datei innerhalb des pro6pp_weltweit_reverse.html direkt vor dem Schließen des </body>-Tags.

    pro6pp_weltweit_reverse.html
      ...
      <script src="pro6pp_weltweit_reverse.js"></script>
     </body>
    </html>

    Um auf den Pro6PP-Webdienst zuzugreifen, müssen Sie Ihren persönlichen Autorisierungsschlüssel anfordern. Dieser Schlüssel wird Ihnen direkt nach der Anmeldung per E-Mail zugeschickt. Ersetzen Sie den obigen Platzhalter AUTH_KEY durch Ihren persönlichen Autorisierungsschlüssel.

    Wenn Sie noch kein Konto haben, melden Sie sich für einen kostenlosen 2 Monate Test an. Nachdem Sie Ihr Konto erstellt haben, gehen Sie zu Ihren Abonnementdetails und kopieren Sie Ihren AUTH_KEY. Sie benötigen diesen Schlüssel, um Ihre Anfragen zu authentifizieren.

  4. In Aktion sehen

    Wenn Sie die vorherigen Schritte abgeschlossen haben, ist es an der Zeit, das Formular lokal in Ihrem Browser auszuführen. Sie sollten nun zwei Dateien im selben Ordner auf Ihrem Computer haben:

    • pro6pp_weltweit_reverse.html - die HTML-Seite mit dem Formular.
    • pro6pp_weltweit_reverse.js - die JavaScript-Datei, die die Interaktion steuert.

    Sie können die HTML-Datei nun in Ihrem Browser öffnen, indem Sie einfach in Ihrem Datei-Explorer (z. B. Finder unter macOS oder Datei-Explorer unter Windows) auf die Datei doppelklicken. Alternativ können Sie die Datei auch manuell im Browser mit dem vollständigen file:///-Pfad öffnen. Zum Beispiel:

    Beispiel für Dateipfade
    file:///C:/Users/YourName/Documents/pro6pp_weltweit_reverse.html
    file:///Users/yourname/Desktop/pro6pp_weltweit_reverse.html

    Sobald die Seite geöffnet ist, geben Sie die Daten in die Formularfelder ein und klicken Sie auf Senden, um die API-Antwort im Abschnitt „Vollständige Antwort“ anzuzeigen.