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": "<string>",
  "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

Response

200
application/json

Success

The response is of type object.