https://github.com/lunyaadev/opensky-client
A lightweight and easy-to-use library to interact with the OpenSky Network API
https://github.com/lunyaadev/opensky-client
opensky opensky-api opensky-client opensky-network openskynetwork
Last synced: 11 months ago
JSON representation
A lightweight and easy-to-use library to interact with the OpenSky Network API
- Host: GitHub
- URL: https://github.com/lunyaadev/opensky-client
- Owner: LunyaaDev
- License: mit
- Created: 2025-07-01T11:24:34.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-01T15:41:26.000Z (12 months ago)
- Last Synced: 2025-07-01T15:58:37.704Z (12 months ago)
- Topics: opensky, opensky-api, opensky-client, opensky-network, openskynetwork
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/opensky-client
- Size: 34.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# 🛫 Opensky Client
A lightweight and easy-to-use library to interact with the [OpenSky Network API](https://www.opensky-network.org).
## ✨ Features
- Uses the new [OAuth2 Client Credentials Flow](https://openskynetwork.github.io/opensky-api/rest.html#oauth2-client-credentials-flow)
- Normalizes API responses into simple, user-friendly formats
- Supports fetching
- [State Vectors](https://openskynetwork.github.io/opensky-api/rest.html#all-state-vectors)
- _(More endpoints coming soon!)_
## 🚀 Example usage
Unauthenticated call to the API to get all states
```ts
import { OpenSkyClient } from 'opensky-client'
const opensky = new OpenSkyClient()
// Get all states
const states = await opensky.getStates()
// Print all state vectors (aircraft infos)
console.log(states)
```
📂 [Authenticated Example](./example/src/index.ts)
## 📊 OpenSky API Rate Limits
| **User Type** | **API Credits** | **Requirement** |
| --- | --- | --- |
| **Unauthenticated** | 400 credits/day | No authentication needed |
| **Default** | 4,000 credits/day | Requires OpenSky account |
| **Active Contributing** | 8,000 credits/day | Requires active ADS-B receiver ≥30% uptime monthly |
Check [Limitations](https://openskynetwork.github.io/opensky-api/rest.html#limitations) for more details about rate limits and other API limitations.
## ⚠️ Disclaimer
This library is in no way officially affiliated with or endorsed by the OpenSky Network.
By using this library, you agree to the [OpenSky Network's Terms of Use and Data License Agreement](https://www.opensky-network.org/terms).