Tidal Prediction Tool Querying
Interactive Documentation
There is interactive documentation for the tide prediction tool. This interactive documentation allows you to build the queries interactively, and guides your parameter selection. To access it, follow these directions:
1. Authorize yourself to access Hakai-API.
You can do this by logging into either the EIMS data portal or via this link: Log In to Hakai-API
2. Go to the interactive Tide Prediction Tool docs
Access the interactive Tide Prediction docs here: Tide Prediction Tool
Bug
Note: occasionally, you may need to refresh the page to have your authorized session recognized.
Parameters for the Tide Prediction Tool
The following parameters are available for the tide prediction tool to help you customize the data you get back.
Station
Stations are set with the station= parameter. You can get a list of all possible values from this
link: https://hecate.hakai.org/api/modelling/tide_prediction/stations
Example
To retrieve 7 days of tide data for Namu, starting from the current time:
Format
Format can be csv, png (image), or json (default). See the examples for how to set the format.
Example
To retrieve 7 days of tide data for Namu, starting from the current time, in json format:
Same query, but get results in csv format:
Same query, but get results as a PNG image:
Date
This is date and time together. You can specify an exact datetime in the format like
2017-02-01T00:32:00.000Z, or just date or year without time (see examples below).
By default the API returns results for the 7 day period starting with the date and time queried. If a time is not given it assumes that the start time for the 7 day period is the current date and time. All times are in UTC.
Example
To retrieve all data for Namu for 7 days, starting January 1, 1998:
To retrieve all data for Cape St. James for 7 days, starting February 1, 1998
To retrieve all data for Ramsay Island for 7 days, starting February 1, 1998 at 00:32 UTC
Duration
Set the duration with the duration= parameter. By default, if unspecified, the duration of the
returned result is 7 days.
Example
To Retrieve all data for 2016 using the duration parameter: