Skip to main content
POST
/
LocationServices
/
DistanceFinder
/
Nearby
/
v1.10
/
json6.ws
cURL
curl --request POST \
  --url https://api.addressy.com/LocationServices/DistanceFinder/Nearby/v1.10/json6.ws \
  --header 'Content-Type: application/json' \
  --data '
{
  "Key": "AA11-AA11-AA11-AA11",
  "AddressId": "<string>",
  "LocationListId": "<string>",
  "Locations": [
    {
      "Id": "<string>",
      "Name": "<string>",
      "Description": "<string>",
      "Address": "<string>",
      "Country": "<string>",
      "Latitude": "<string>",
      "Longitude": "<string>",
      "MetaInfo": {},
      "UnstructuredMetaInfo": {},
      "OpeningHours": {
        "Monday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Tuesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Wednesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Thursday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Friday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Saturday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Sunday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        }
      }
    }
  ],
  "OriginLocation": {
    "Id": "<string>",
    "Name": "<string>",
    "Description": "<string>",
    "Address": "<string>",
    "Country": "<string>",
    "Latitude": "<string>",
    "Longitude": "<string>",
    "MetaInfo": {},
    "UnstructuredMetaInfo": {},
    "OpeningHours": {
      "Monday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Tuesday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Wednesday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Thursday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Friday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Saturday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Sunday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      }
    }
  },
  "MaxDistance": 123,
  "InputUnit": 0,
  "MaxResults": 123,
  "OrderBy": 0,
  "TransportationType": 0
}
'
{
  "OriginLocation": {
    "Id": "<string>",
    "Name": "<string>",
    "Description": "<string>",
    "Address": "<string>",
    "Country": "<string>",
    "Latitude": "<string>",
    "Longitude": "<string>",
    "MetaInfo": {},
    "UnstructuredMetaInfo": {},
    "OpeningHours": {
      "Monday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Tuesday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Wednesday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Thursday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Friday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Saturday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      },
      "Sunday": {
        "Open": "<string>",
        "Close": "<string>",
        "Information": "<string>"
      }
    }
  },
  "DestinationLocations": [
    {
      "DestinationLocation": {
        "Id": "<string>",
        "Name": "<string>",
        "Description": "<string>",
        "Address": "<string>",
        "Country": "<string>",
        "Latitude": "<string>",
        "Longitude": "<string>",
        "MetaInfo": {},
        "UnstructuredMetaInfo": {},
        "OpeningHours": {
          "Monday": {
            "Open": "<string>",
            "Close": "<string>",
            "Information": "<string>"
          },
          "Tuesday": {
            "Open": "<string>",
            "Close": "<string>",
            "Information": "<string>"
          },
          "Wednesday": {
            "Open": "<string>",
            "Close": "<string>",
            "Information": "<string>"
          },
          "Thursday": {
            "Open": "<string>",
            "Close": "<string>",
            "Information": "<string>"
          },
          "Friday": {
            "Open": "<string>",
            "Close": "<string>",
            "Information": "<string>"
          },
          "Saturday": {
            "Open": "<string>",
            "Close": "<string>",
            "Information": "<string>"
          },
          "Sunday": {
            "Open": "<string>",
            "Close": "<string>",
            "Information": "<string>"
          }
        }
      },
      "Distance": "<string>",
      "DistanceMiles": "<string>",
      "DistanceMeters": 123,
      "Time": "<string>",
      "TimeSeconds": 123
    }
  ]
}
Please note that there are no limits to how many points you can send us, however your results returned will be limited to the nearest 100 points within a maximum of a 500km radius. In general there is a linear correlation between number of points/distance and response times. Due to this we recommend limiting to the fewest points possible for your application. Travel times are calculated using historical traffic data. This API supports most international locations. Distance calculation is supported between countries (e.g. France to Germany) provided that those countries are within the same region (e.g. Europe, Africa, Asia). This method will consume credit. It is charged per request regardless of the number of destinations.

Body

application/json
​
Key
string
default:AA11-AA11-AA11-AA11
required

The key used to authenticate with the service. For example: 'AA11-AA11-AA11-AA11'

​
AddressId
string | null
​
LocationListId
string | null

A GuID that identifies a list previously created using our Create List API. When this field is populated with a valid ID, the API will utilise the list for your destination locations.

​
Locations
object[] | null

An array of strings that is populated with information about a location. Any points in the locations object will be used to calculate distances from your origin location. If not using a previously uploaded Location List then at least one location must be sent in the request.

​
OriginLocation
object

An array of strings that is populated with information about your origin location. This will be the starting point for all distances calculated via the API.

​
MaxDistance
number<double>

The maximum straight line distance radius of results that will be returned, starting from the original location, in metres. For example, setting a maxDistance of 100000 will only return results within a 100km radius of the origin. By default this is set to 100km with a maximum value of 500km. A smaller search radius will improve performance.

​
InputUnit
enum<integer>
Available options:
0,
1,
2
​
MaxResults
integer<int32>

The maximum number of locations you want returned. By default this is set to 10 with a maximum value of 100. Reducing the number of results returned will also improve performance.

​
OrderBy
enum<integer>

The order in which you want results to be returned. By default this will return locations in ascending distance order (i.e. closest location first). Time can be passed instead, to return in order of ascending travel time.

Available options:
0,
1
​
TransportationType
enum<integer>
Available options:
0,
1,
2,
3,
4,
5,
6,
7

Response

Success

​
OriginLocation
object

An array of strings containing the originLocation from the original request.

​
DestinationLocations
object[] | null

An array of objects containing the destination locations and results for distance/time calculation.