N2yo Satellites
@hmcrum/n2yo-satellitesv2026.09.17.1
01README
Real-time satellite tracking against the N2YO REST API. Two methods: above lists every tracked satellite currently within a search radius over an observer's lat/lng ("what's flying overhead right now"), and passes predicts the next visible passes of one specific satellite (by NORAD catalog ID) over that location.
Read-only, host-locked to api.n2yo.com. Requires a free N2YO API key (https://www.n2yo.com/api/) stored in a vault — a missing or invalid key degrades to an errors entry and an empty result rather than throwing.
Quick Start
--input apiKey='${{ vault.get("briefing", "N2YO_API_KEY") }}'
swamp model method run sky above --input latitude=40.7128 --input longitude=-74.0060 swamp model method run sky passes --input satelliteId=25544 \
--input latitude=40.7128 --input longitude=-74.006002Models
@hmcrum/n2yo-satellitesv2026.09.17.1n2yo_satellites.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiKey | string | N2YO API key (free at https://www.n2yo.com/api/), e.g. ${{ vault.get("briefing", "N2YO_API_KEY") }} |
| userAgent | string | User-Agent sent to api.n2yo.com — identify yourself honestly |
fn above(latitude: number, longitude: number, altitude: number, searchRadiusDeg: number, categoryId: number)
List satellites currently flying within a search radius above an observer's lat/lng — 'what's overhead right now'. Read-only, one call.
| Argument | Type | Description |
|---|---|---|
| latitude | number | Observer latitude, e.g. 40.7128 |
| longitude | number | Observer longitude, e.g. -74.0060 |
| altitude | number | Observer altitude above sea level, in meters |
| searchRadiusDeg | number | Search cone radius in degrees (0-90) around the observer's zenith |
| categoryId | number | N2YO satellite category filter — 0 means all categories. |
fn passes(satelliteId: number, latitude: number, longitude: number, altitude: number, daysAhead: number, minVisibility: number)
Predict the next visible passes of one satellite (by NORAD catalog ID) over an observer's lat/lng. Read-only, one call.
| Argument | Type | Description |
|---|---|---|
| satelliteId | number | NORAD catalog ID of the satellite, e.g. 25544 for the ISS |
| latitude | number | Observer latitude, e.g. 40.7128 |
| longitude | number | Observer longitude, e.g. -74.0060 |
| altitude | number | Observer altitude above sea level, in meters |
| daysAhead | number | How many days ahead to search for passes (N2YO caps at 10) |
| minVisibility | number | Minimum visible duration in seconds for a pass to be included |
Resources
above(5m)— Satellites currently within a search radius above an observer's location
passes(30m)— Predicted visible passes of one satellite over an observer's location
03Stats
A
100 / 100
Downloads
14
Archive size
8.5 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
04Platforms
05Labels