This API provides information about a place, given its ID.
Place information needs just a place number and the API key.
The URL for the request will look something like this:
https://tidespy.com/api/place?pn=1341&key=...
pn parameter is the number of the required place.
The number for a place can be found manually by searching on TideSpy:
https://tidespy.com/alphaPlaceIndex.
Hover over an icon and get the place number from the URL displayed by the browser, or use one of the other APIs to get a place number.
There is also a wildcard name search in the API, or you can use the Places within radius API call.
{
Ok: true,
Number: 1341,
Name: "South Fork",
State: "Florida",
Area: "St. Lucie River",
Country: "USA",
HasTideInfo: true
}
A typical response is shown above on the right.
Ok is true or false. If false, a Message element will be included with more information.
Number is the place number echoed back.
Name is the name of the place.
Area is a name for the general area in which the place is located.
State is the name of the state where applicable, or is empty.
Country is the name of the country.
HasTideInfo is true if tide information (i.e. height predictions) are available for this place, otherwise false.