RapidAPI logo

Sign Up

Log In

uk.boundaries.io

PAID
By VanitySoft
Updated 3 months ago
Data
5.6/10
Popularity Score
927ms
Latency
99%
Success Rate

uk.boundaries.io API Documentation

UK Postal Code(ex. ZE1 0AE), Sector, District, Boundaries API:

A simple & very fast API that will allow you to integrate multiple GeoJson UK Unit and sector level boundaries result into your apps and systems. This API is designed to be used programatically for optimal performance. When using the MashApe UI for queries expect significant latency issues on large result sets!

View API Details
Retrieve UK Geojson Boundaries
GETRetrieve UK Postal Unit Boundaries
GETRetrieve UK Postal Sector Outline Boundaries
GETRetrieve UK Postal District Outline Boundaries
GETRetrieve UK Postal Unit Boundaries

Get UK Postal-Unit(ex. ZE1 0AE) ,Sector,District, boundaries in GeoJson Formats. The MashAPI UI cannot handle large results(we default to 30 limit), this API is meant to be used programatically. Thanks. Copy & paste results: http://geojsonlint.com for a quick view.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Optional Parameters
andBOOLEAN
OPTIONALPerform and "AND"(true), "OR"(false) query on request parameters...DEFAULT IS FALSE.
postal-unitSTRING
OPTIONALQuery by postal units. for example 'ZE1 0AE", or multiples.
limitNUMBER
OPTIONAL
postal-sectorSTRING
OPTIONALQuery by Ward. for example "ZE1 0", or multiples.
showSectorsBOOLEAN
OPTIONALShow all Postal unit boundaries within Sectors of results.
postal-districtSTRING
OPTIONALQuery by postal-district , Example "W4"
Request Snippet
unirest.get("https://vanitysoft-uk-boundaries-io-v1.p.rapidapi.com/reaperfire/rest/v1/public/boundary/uk?postal-unit=ZE1+0AE&limit=1000&postal-sector=ZE1+0&showSectors=false")
.header("X-RapidAPI-Host", "vanitysoft-uk-boundaries-io-v1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
Log inSign up

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.get("https://vanitysoft-uk-boundaries-io-v1.p.rapidapi.com/reaperfire/rest/v1/public/boundary/uk?postal-unit=ZE1+0AE&limit=1000&postal-sector=ZE1+0&showSectors=false")
.header("X-RapidAPI-Host", "vanitysoft-uk-boundaries-io-v1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication