This API provides a list of places within a given radius of a position
A typical request might look like this:
https://tidespy.com/api/place?lat=-43.6&lng=172.8&radius=10&key=...
Where:
lat is the latitude in decimal degrees, negative for South.
lng is the longitude in decimal degrees, negative for West.
radius is the area to be searched, in kilometres as an integer between 1 and 100.
A typical response is shown on the right, with this data:
SearchLatitude
SearchLongitude
SearchRadiusKm:
These three elements simply echo back the search terms.
Ok
Returns true or false. A false response will generally also contain a message. If there are no places within the requested radius it is not considered an error; the Places array in the response will simply be empty.
Note that, as of 14 Apr 2015, the array of places is arranged in order of distance from the search lat/long.
Places:
An array of the places that satisfy the search. For each place:
Number: The number of the place for use in other calls.
Name: A semi-colon-separated list of the place name elements in this form:
<place name>;<area name>;<state>;<country>
Note that <area name> and/or <state> may be empty.
DistanceKm: The distance in kilometres between this place and the requested position.
The calculations used to compute distance between two lat/long positions is based on a spherical earth and are not rigorous, however values will generally be within a few percent of the correct value.
https://tidespy.com/api/place?lat=-43.6&lng=172.8&radius=10&key=...
{
SearchLatitude: "-43.6",
SearchLongitude: "172.8",
SearchRadiusKm: "10",
Ok: true,
Places:
[
{
Number: "3152",
Name: "Taylors Mistake;Banks Peninsula;;New Zealand",
DistanceKm: "2.5"
},
{
Number: "3142",
Name: "Sumner;Banks Peninsula;;New Zealand",
DistanceKm: "4.2"
},
{
Number: "3122",
Name: "Port Levy;Banks Peninsula;;New Zealand",
DistanceKm: "5.7"
},
{
Number: "3056",
Name: "Lyttelton;Banks Peninsula;;New Zealand",
DistanceKm: "7.1"
},
]
}