Suggest Great Britain

Overview

ParametersQuery string

Responses

[
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AA",
    "lat": 51.541,
    "lng": -0.094,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AD",
    "lat": 51.54,
    "lng": -0.094,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AE",
    "lat": 51.541,
    "lng": -0.092,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AF",
    "lat": 51.541,
    "lng": -0.092,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AH",
    "lat": 51.543,
    "lng": -0.091,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AJ",
    "lat": 51.542,
    "lng": -0.089,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AL",
    "lat": 51.542,
    "lng": -0.087,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AP",
    "lat": 51.541,
    "lng": -0.095,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AQ",
    "lat": 51.542,
    "lng": -0.091,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "postalCode": "N1 3AR",
    "lat": 51.542,
    "lng": -0.093,
    "district": "Hackney",
    "settlements": [
      "Barnsbury",
      "Canonbury",
      "De Beauvoir Town",
      "Hoxton",
      "Islington",
      "Kings Cross",
      "Pentonville"
    ]
  }
]

Errors

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

{
  "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"
    }
  ]
}

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

{
  "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/suggest/gb/postalCode?postalCode=N1+3&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 Great Britain Suggest 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_great-britain_suggest.html. Add the following code between the <body> and </body> tags. It adds the input fields for entering the address.

   pro6pp_great-britain_suggest.htmlCopy

   <form class="form" id="form">
     <div>Call</div>
     <div>
       <label for="postalCode">postalCode:</label>
       <input id="postalCode" class="postalCode" placeholder="N1 3"/>
       <label for="maxResults">maxResults:</label>
       <input id="maxResults" class="maxResults" placeholder=""/>
       <label for="cursor">cursor:</label>
       <input id="cursor" class="cursor" 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>

   Show full code

2. Add interaction

   Add the following JavaScript code in a separate pro6pp_great-britain_suggest.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_great-britain_suggest.jsCopy

   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 = {
               postalCode: document.getElementById("postalCode").value,
               authKey: authKey
           };
           const optionalQueryParams = [
               "maxResults",
               "cursor",
           ];
           for (const name of optionalQueryParams) {
               const value = document.getElementById(name).value;
               if (value !== "") {
                   queryParams[name] = value;
               }
           }
   
           let encodedUrl = new URL(`${BASE_URL}/suggest/gb/postalCode`);
           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);
       }
   });

   Show full code

3. Make it work

   Link the JavaScript file inside the pro6pp_great-britain_suggest.html right before closing the </body> tag.

   pro6pp_great-britain_suggest.htmlCopy

     ...
     <script src="pro6pp_great-britain_suggest.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_great-britain_suggest.html - the HTML page with the form.
   • pro6pp_great-britain_suggest.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 pathsCopy

   file:///C:/Users/YourName/Documents/pro6pp_great-britain_suggest.html
   file:///Users/yourname/Desktop/pro6pp_great-britain_suggest.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.