Reverse Global

Bèta

Een breedtegraad/lengtegraad omkeren naar een adres.

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

Overzicht

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.

ParametersQuerystring

authKeystringVereist

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.

latnumberVereist

The latitude.

Voorbeeld
52.36691
lngnumberVereist

The longitude.

Voorbeeld
4.89489
precisionstring

The precision to search either street or streetnumber

Voorbeeld
street
Waarden
streetstreetnumber

Antwoorden

200Address found
VeldTypeVoorbeeldwaardeBeschrijving
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.

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

Fouten

Velden van een foutantwoord
VeldTypeBeschrijving
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.

400Ongeldig verzoek
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"
    }
  ]
}
401Niet geautoriseerd
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"
    }
  ]
}
404Geen resultaat
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"
    }
  ]
}

Codevoorbeelden

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

Wij moedigen u aan om voorbeeldcode aan te vragen in de taal van uw voorkeur.

Stap voor stap

Stel snel een formulier in om de functionaliteit Global Reverse uit te proberen door de onderstaande stappen te volgen.

  1. Bouw de HTML-pagina

    We beginnen met het maken van een lege HTML-pagina, die een minimale webpaginastructuur bevat. Voeg de volgende code toe tussen de tags <body> en </body>. Het voegt de invoervelden toe voor het invoeren van het adres. Maak een nieuw .html bestand met de naam {filename}}.

    pro6pp_global_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. Voeg interactie toe

    Voeg de volgende JavaScript-code toe in een apart {filename}}-bestand. De ID's en Class-namen van de HTML-elementen moeten overeenkomen met die in dit JavaScript-bestand om de juiste resultaten te krijgen.

    pro6pp_global_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. Laat het werken

    Koppel het JavaScript-bestand binnen de pro6pp_global_reverse.html vlak voor het sluiten van de code </body>.

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

    Om toegang te krijgen tot de Pro6PP web service, moet u uw persoonlijke autorisatiesleutel aanvragen. Deze sleutel wordt direct na aanmelden naar u gemaild. Vervang de tijdelijke aanduiding AUTH_KEY door uw persoonlijke autorisatiesleutel.

    Als u nog geen account heeft, meldt u zich dan aan voor een gratis proefabonnement van 2 maanden. Nadat u uw account hebt aangemaakt, gaat u naar uw Abonnementsgegevens en kopieert u uw AUTH_KEY. U heeft deze sleutel nodig om uw aanvragen te verifiëren.

  4. Zie het in actie

    Als u de vorige stappen heeft uitgevoerd, is het tijd om het formulier lokaal in uw browser uit te voeren. U zou nu twee bestanden in dezelfde map op uw computer moeten hebben:

    • pro6pp_global_reverse.html - de HTML-pagina met het formulier.
    • pro6pp_global_reverse.js - het JavaScript-bestand dat de interactie afhandelt.

    U kunt het HTML-bestand nu openen in uw browser door er simpelweg dubbel op te klikken in uw bestandsverkenner (bijvoorbeeld Finder op macOS of File Explorer op Windows). U kunt het ook handmatig in de browser openen met het volledige file:/// pad. Bijvoorbeeld:

    Voorbeeld bestandspaden
    file:///C:/Users/YourName/Documents/pro6pp_global_reverse.html
    file:///Users/yourname/Desktop/pro6pp_global_reverse.html

    Zodra de pagina wordt geopend, begint u met het typen van de formuliervelden en drukt u op Submit om het API-antwoord te zien in het gedeelte “Full Response”.