--- title: "LocationServices_DistanceFinder_Nearby" method: POST path: "/LocationServices/DistanceFinder/Nearby/v1.10/json6.ws" tags: ["LocationServices_DistanceFinder_Nearby"] --- # LocationServices_DistanceFinder_Nearby `POST /LocationServices/DistanceFinder/Nearby/v1.10/json6.ws` ## Request - Base URL: `https://api.addressy.com` - URL: `https://api.addressy.com/LocationServices/DistanceFinder/Nearby/v1.10/json6.ws` - Auth: API key in query parameter `Key` ## Request body - object - `Key` string, required: The key you want to use to authenticate with the service (you can request we create one for you or create one in your [account section](https://account.loqate.com/account#/)). - `AddressId` string - `LocationListId` string: A GuID that identifies a list previously created using our [Create List](/api-reference/store-finder/create-list) API. When this field is populated with a valid ID, the API will utilise the list for your destination locations. - `Locations` PointData[]: 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.** - `Id` string: Identifier for the location. This must be unique for each location provided within the request. - `Name` string: Name of the location. - `Description` string: Description of the location for display purposes. - `Address` string: Address of the location for display purposes. - `Country` string - `Latitude` string: The WGS 84 latitude in decimal degrees format. - `Longitude` string: The WGS 84 longitude in decimal degrees format. - `MetaInfo` object - `UnstructuredMetaInfo` object - `OpeningHours` OpeningHours - `Monday` Day - `Open` string - `Close` string - `Information` string - `Tuesday` Day - `Open` string - `Close` string - `Information` string - `Wednesday` Day - `Open` string - `Close` string - `Information` string - `Thursday` Day - `Open` string - `Close` string - `Information` string - `Friday` Day - `Open` string - `Close` string - `Information` string - `Saturday` Day - `Open` string - `Close` string - `Information` string - `Sunday` Day - `Open` string - `Close` string - `Information` string - `OriginLocation` PointData - `Id` string: Identifier for the location. This must be unique for each location provided within the request. - `Name` string: Name of the location. - `Description` string: Description of the location for display purposes. - `Address` string: Address of the location for display purposes. - `Country` string - `Latitude` string: The WGS 84 latitude in decimal degrees format. - `Longitude` string: The WGS 84 longitude in decimal degrees format. - `MetaInfo` object - `UnstructuredMetaInfo` object - `OpeningHours` OpeningHours - `Monday` Day - `Open` string - `Close` string - `Information` string - `Tuesday` Day - `Open` string - `Close` string - `Information` string - `Wednesday` Day - `Open` string - `Close` string - `Information` string - `Thursday` Day - `Open` string - `Close` string - `Information` string - `Friday` Day - `Open` string - `Close` string - `Information` string - `Saturday` Day - `Open` string - `Close` string - `Information` string - `Sunday` Day - `Open` string - `Close` string - `Information` string - `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` 'Meters' | 'Miles' | 'Kilometers' - `MaxResults` integer: 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` 'Distance' | 'Time' ## Response `200` Success - object - `OriginLocation` ExternalResponsePointData - `Id` string: Identifier for the location. - `Name` string: Name of the location. - `Description` string: Description of the location for display purposes. - `Address` string: Address of the location for display purposes. - `Country` string - `Latitude` string: The WGS 84 latitude in decimal degrees format. - `Longitude` string: The WGS 84 longitude in decimal degrees format. - `MetaInfo` object - `UnstructuredMetaInfo` object - `OpeningHours` ExternalResponseOpeningHours - `Monday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Tuesday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Wednesday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Thursday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Friday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Saturday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Sunday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `DestinationLocations` ExternalResponseDestinationLocation[]: An array of objects containing the destination locations and results for distance/time calculation. - `DestinationLocation` ExternalResponsePointData - `Id` string: Identifier for the location. - `Name` string: Name of the location. - `Description` string: Description of the location for display purposes. - `Address` string: Address of the location for display purposes. - `Country` string - `Latitude` string: The WGS 84 latitude in decimal degrees format. - `Longitude` string: The WGS 84 longitude in decimal degrees format. - `MetaInfo` object - `UnstructuredMetaInfo` object - `OpeningHours` ExternalResponseOpeningHours - `Monday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Tuesday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Wednesday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Thursday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Friday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Saturday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Sunday` ExternalResponseDay - `Open` string - `Close` string - `Information` string - `Distance` string: The distance by road in kilometres returned as a string. - `DistanceMiles` string: The distance by road in miles returned as a string. - `DistanceMeters` integer, nullable: The distance by road in metres returned as an integer. - `Time` string: The travel time displayed as seconds, minutes or hours. - `TimeSeconds` integer, nullable: The travel time displayed in seconds as an integer. ## Other responses - `400`: BadRequest - `401`: Unauthorized - `403`: Forbidden - `500`: InternalServerError --- [API](https://skmtc.dev/loqate/apis/locationservices-distancefinder-nearby.md) - [All operations](https://skmtc.dev/loqate/apis/locationservices-distancefinder-nearby/llms.txt) - [OpenAPI document](https://skmtc.dev/loqate/apis/locationservices-distancefinder-nearby/revisions/1db0f5edbf69?raw)