https://github.com/hakaiinstitute/tides_api
A tide API for CHS modelled stations
https://github.com/hakaiinstitute/tides_api
eims tides
Last synced: 8 months ago
JSON representation
A tide API for CHS modelled stations
- Host: GitHub
- URL: https://github.com/hakaiinstitute/tides_api
- Owner: HakaiInstitute
- Created: 2024-03-15T20:07:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-30T19:59:47.000Z (about 1 year ago)
- Last Synced: 2025-06-12T01:41:52.167Z (12 months ago)
- Topics: eims, tides
- Language: Python
- Homepage: https://tides.server.hakai.app
- Size: 145 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Absolutely! Here's a GitHub repo README.md for a project maintaining the API described by your openapi.json file.
# Tide Window API
## Description
This project provides an API for retrieving tide windows at various coastal stations. Tide windows are periods of time when the tide height falls within a specified range. This data can be useful for activities like fishing, boating, or coastal research.
**Important Note:** This tool remains under development. Results may occasionally be inaccurate, and URLs may be subject to change. Please use at your own risk.
## Usage
The Tide Window API has several useful endpoints:
* **List Available Stations (`/stations`)**
- Returns a list of stations with or without coordinates.
* **Show Stations on a Map (`/stations/map`)**
- Displays an interactive map with station locations.
* **Get Station-Specific Info (`/stations/{station_name}`)**
- Provides detailed station information, including coordinates, if requested.
* **Interactive Tide Plot (`/tides/events/{station_name}/plot`)**
- Generates a visual plot of tides, sunrise/sunset times, and specified tide windows for a chosen station and date range.
* **Tide Events in CSV Format (`/tides/events/{station_name}.csv`)**
- Downloads tide events (low tides, high tides, sunrise, sunset) as a CSV file, including optional tide window data.
* **Tide Events in JSON Format (`/tides/events/{station_name}`)**
- Provides tide events in a structured JSON format, including optional tide window data.
* **Raw Tide Data (`/tides/{station_name}`)**
- Returns a JSON array of tide measurements (time and height).
### Example Usage (Interactive Tide Plot)
```
https://goose.hakai.org/tide_windows/tides/events/Abbotts%20Harbour/plot?start_date=2024-08-01&end_date=2024-08-03&tide_window=1.5&tide_window=2.0
```
## Parameters
Refer to the OpenAPI specification for a full list of supported parameters. Common parameters include:
* `station_name`
* `start_date` (ISO8601 format)
* `end_date` (ISO8601 format)
* `tz` (Timezone)
* `tide_window` (Array specifying tide heights in meters)
## Getting Started
1. **Explore the OpenAPI Specification:** The OpenAPI spec (openapi.json) provides complete details about the API's structure and endpoints.
2. **Try It Out:** Experiment with the endpoints directly on the Goose website ([invalid URL removed])
## Contributing
We welcome contributions to improve and expand this API. Please create issues or submit pull requests.
## Contact
For questions or support, email api.support@hakai.org