Tidal Forecast Parameters
Request parameters | Response parameters
Tidal Forecast API Query String Parameters
| Parameter | Description | Default value | |
|---|
| api |
Hostname to be used only in production: api.accuweather.com |
N/A |
Required |
| apidev |
Hostname to be used only in development: apidev.accuweather.com |
N/A |
Required |
| apikey |
Unique code used to access the API |
N/A |
Required |
| version |
Current version of the API |
v1 |
Required |
| locationkey |
Unique ID used to search for a specific location (required for forecast queries) |
N/A |
Required |
| stationId |
Unique ID used to search for a specific tidal station (required for station queries) |
N/A |
Required |
| format |
Format of the response |
JSON |
Optional |
| language |
String indicating the language in which to return the resource |
en-us |
Optional |
| allowError |
If allowError=false, the api will return a 200 response when it otherwise would have returned at 400 or 500 response |
True |
Optional |
Top of page
Tidal forecast response parameters
| Parameter | Description |
|---|
| Date |
Datetime of the forecast, displayed in ISO8601 format: yyyy-mm-ddThh:mm:ss±hh:mm |
| EpochTime |
Datetime of the forecast, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT) |
| Forecasts |
|
|
Station |
|
|
|
ID |
Unique station code for the tidal station |
|
|
Name |
Station name displayed in the local dialect set with the language code in the URL. If no language code is selected, the default is US English (us-en) |
|
|
Primary |
Is this the primary tidal station for the location set with locationKey in the URL? True or False |
|
Tides |
|
|
|
DateTime |
Datetime of the tide, displayed in ISO8601 format: yyyy-mm-ddThh:mm:ss±hh:mm |
|
|
EpochTime |
Datetime of the tide, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT) |
|
|
Type |
Tide type (low or high) |
|
|
Height |
Contains metric and imperial values for tide height. |
|
|
|
Metric |
|
|
|
|
|
Value |
Rounded value in the specified units |
|
|
|
|
Unit |
Type of unit |
|
|
|
|
UnitType |
Numeric ID associated with the type of unit being displayed |
|
|
|
Imperial |
|
|
|
|
|
Value |
Rounded value in the specified units |
|
|
|
|
Unit |
Type of unit |
|
|
|
|
UnitType |
Numeric ID associated with the type of unit being displayed |
| MobileLink |
Link to tidal forecasts on AccuWeather's mobile website |
| Link |
Link to tidal forecasts on AccuWeather's website |
Top of page
Tidal station metadata response parameters
| Parameter | Description |
|---|
| Station |
|
|
ID |
Unique station code for the tidal station |
|
Name |
Station name |
|
Primary |
Is this the primary tidal station for the location set with locationKey in the URL? True or False |
| GeoPosition |
|
|
Latitude |
Station latitude |
|
Longitude |
Station longitude |
| TimeZone |
|
|
Code |
Official abbreviation code for designated Time Zone |
|
Name |
Official name of designated Time Zone |
|
GmtOffset |
GMT offset of the weather station. May be NULL. |
| Country |
|
|
ID |
Unique ISO or Microsoft Localization Code for the country |
|
Name |
Country name displayed in English |
| AdministrativeArea |
|
|
ID |
Unique Administrative Area ID for the Location |
|
Name |
Administrative Area name displayed in English |
|
Level |
An assigned number, describing the scale of the administrative subdivisions for countries. As the Level number increases, the scale of the subdivision will decrease. Numbers of 10 or greater are reserved for non-political boundaries and should be used independently. May be NULL |
|
CountryID |
Unique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea |
Top of page