Skip to content

Commit 17e3cc4

Browse files
committed
Update api docs
1 parent 027ba21 commit 17e3cc4

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

packages/api/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# @neaps/api
22

3-
HTTP JSON API for tide predictions using NOAA harmonic constituents.
3+
HTTP JSON API for tide predictions using [neaps](https://github.com/neaps/neaps).
44

55
## Installation
66

77
```bash
8-
npm install @neaps/api express
8+
npm install @neaps/api
99
```
1010

1111
## Usage
@@ -46,8 +46,8 @@ Get high and low tide predictions for the nearest station to given coordinates.
4646

4747
**Query Parameters:**
4848

49-
- `lat` or `latitude` (required): Latitude (-90 to 90)
50-
- `lon`, `lng`, or `longitude` (required): Longitude (-180 to 180)
49+
- `latitude` (required): Latitude (-90 to 90)
50+
- `longitude` (required): Longitude (-180 to 180)
5151
- `start` (required): Start date/time in ISO 8601 format
5252
- `end` (required): End date/time in ISO 8601 format
5353
- `datum` (optional): Vertical datum (MLLW, MLW, MTL, MSL, MHW, MHHW)
@@ -56,7 +56,7 @@ Get high and low tide predictions for the nearest station to given coordinates.
5656
**Example:**
5757

5858
```bash
59-
curl "http://localhost:3000/extremes?lat=26.772&lon=-80.05&start=2025-12-17T00:00:00Z&end=2025-12-18T00:00:00Z&datum=MLLW&units=feet"
59+
curl "http://localhost:3000/extremes?latitude=26.772&longitude=-80.05&start=2025-12-17T00:00:00Z&end=2025-12-18T00:00:00Z&datum=MLLW&units=feet"
6060
```
6161

6262
### GET /timeline
@@ -68,7 +68,7 @@ Get water level predictions at regular intervals for the nearest station.
6868
**Example:**
6969

7070
```bash
71-
curl "http://localhost:3000/timeline?lat=26.772&lon=-80.05&start=2025-12-17T00:00:00Z&end=2025-12-18T00:00:00Z"
71+
curl "http://localhost:3000/timeline?latitude=26.772&longitude=-80.05&start=2025-12-17T00:00:00Z&end=2025-12-18T00:00:00Z"
7272
```
7373

7474
### GET /stations
@@ -78,8 +78,8 @@ Find stations by ID or near a location.
7878
**Query Parameters:**
7979

8080
- `id` (optional): Station ID or source ID
81-
- `lat` or `latitude` (optional): Latitude for proximity search
82-
- `lon`, `lng`, or `longitude` (optional): Longitude for proximity search
81+
- `latitude` (optional): Latitude for proximity search
82+
- `longitude` (optional): Longitude for proximity search
8383
- `limit` (optional): Maximum number of stations to return (1-100, defaults to 10)
8484

8585
**Examples:**
@@ -89,7 +89,7 @@ Find stations by ID or near a location.
8989
curl "http://localhost:3000/stations?id=noaa/8722588"
9090

9191
# Find stations near coordinates
92-
curl "http://localhost:3000/stations?lat=26.772&lon=-80.05&limit=5"
92+
curl "http://localhost:3000/stations?latitude=26.772&longitude=-80.05&limit=5"
9393
```
9494

9595
### GET /stations/:id/extremes

0 commit comments

Comments
 (0)