Skip to main content

Find nearby addresses

Retrieve property addresses based on search params or latitude and longitude.

Paramaters​

There are two ways of searching for nearby locations.

search - (string) required if not using lat/lng​

This can be a building name, property address, county, or city.

lat - (string) required if not using search​

The latitude of the location of interest.

lng - (string) required if not using search​

The longitude of the location of interest.

radius - (int) optional​

in meters, what is the radius you want to search from the point of location? The default is 50 meters.

Note: the larger the radius, the longer the loadtime.

residential - (int) optional​

Do you want to filter the response for residential addresses only? Default is false. Don't include this paramater if you want commercial buildings included along with residential

verify_address - (int) optional​

Do you want us to verify the locations found with the USPS? Default is false. Don't include this paramater if you don't want to verify addresses

Note: if you choose to verify addresses, we recommend decreasing your search radius.

limit - (int) optional​

The number of nearby addresses returned. The default is no limit.

Note: the larger the limit, the longer the loadtime.

page_limit - optional​

Number of records returned on each page. Defaults to 10.

page - optional​

Page number of data returned. Defaults to first page. If the value is greater than the last page found, the last page is returned.

Code Example​

GET - https://api.particlespace.com/api/v1/property/nearby
var axios = require('axios');
const BEARER_TOKEN = 'SET_ME';
var config = {
  method: 'get',
  url: 'https://api.particlespace.com/api/v1/property/nearby?search=the white house&page_limit=4&page=3',
  headers: {
    'Authorization': 'Bearer ' + BEARER_TOKEN
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});