https://github.com/vineyardbovines/tidesandcurrents
node wrapper for the NOAA Tides and Currents API
https://github.com/vineyardbovines/tidesandcurrents
noaa noaa-api tides tidesandcurrents
Last synced: 3 months ago
JSON representation
node wrapper for the NOAA Tides and Currents API
- Host: GitHub
- URL: https://github.com/vineyardbovines/tidesandcurrents
- Owner: vineyardbovines
- License: mit
- Created: 2020-08-05T17:43:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T14:38:12.000Z (over 1 year ago)
- Last Synced: 2024-11-17T21:29:22.189Z (7 months ago)
- Topics: noaa, noaa-api, tides, tidesandcurrents
- Language: TypeScript
- Homepage:
- Size: 155 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NOAA Tides and Currents API
Node wrapper around the [NOAA Tides and Currents API](https://api.tidesandcurrents.noaa.gov/api/prod).
## Usage
```
yarn add tidesandcurrents
```
### `get(stationId: number, params?: {})`
Make a generic call to the tides and currents API.
All params valid to pass can be found [here](https://api.tidesandcurrents.noaa.gov/api/prod).
```js
import tidesandcurrents from 'tidesandcurrents'
// the `now` method returns today's date as 'yyyymmdd'.
const currentAirTemperature = tidesandcurrents.get(8410140, {
product: 'air_temperature',
date: tidesandcurrents.now
});
```
### `tidePredictions(stationId: number, date?: string)`
Get the day's high/low tide predictions. Date param defaults to today.
```js
import tidesandcurrents from 'tidesandcurrents'
// date defaults to today
const tidePredictions = tidesandcurrents.tidePredictions(8410140)
// or you can specify a past/future date
const yesterdaysTidePredictions = tidesandcurrents.tidePredictions(8410140, '20201231')
// returns an array of the day's predictions
// [
// { t: '2020-08-05 00:26', v: '19.640', type: 'H' },
// { t: '2020-08-05 06:53', v: '-0.412', type: 'L' },
// { t: '2020-08-05 12:54', v: '18.423', type: 'H' },
// { t: '2020-08-05 19:10', v: '0.786', type: 'L' }
// ]
```
### `stationMetadata(stationId: number)`
Gets station metadata info -- id, name, latitude, and longitude.
```js
import tidesandcurrents from 'tidesandcurrents'
const stationMetadata = tidesandcurrents.stationMetadata(8410140)
// returns
// {
// id: '8410140',
// name: 'Eastport',
// state: 'ME',
// latitude: '44.9046',
// longitude: '-66.9829'
// }
```
### `currentWaterLevel(stationId: number)`
Gets the current water level for a given station.
```js
import tidesandcurrents from 'tidesandcurrents'
const currentWaterLevel = tidesandcurrents.currentWaterLevel(8410140)
// return
// {
// "f": "0,0,0,0",
// "q": "p",
// "s": "0.072",
// "t": "2020-08-06 16:06",
// "v": "7.151",
// }
```