opensky-api

OpenSky

Quality Check Stability: Stable npm codecov npm bundle size npm downloads LICENSE

Lightweight API wrapper for OpenSky’s REST API. The API lets you retrieve live airspace information for research and non-commercial purposes. Please refer to OpenSky Network API documentation.

This project is not affiliated to OpenSky Network, but the codebase is heavily inspired by the opensky-api Java implementation.

πŸ“¦ Install

yarn add opensky-api
# or
pnpm add opensky-api
# or
npm install opensky-api --save

⚑️ Quick start

The following example is equivalent to calling the REST API: https://opensky-network.org/api/states/all?time=1458564121&icao24=3c6444

import { OpenSkyApi } from 'opensky-api';

const api = OpenSkyApi();

api
.getStates(1458564121, ['3c6444'])
.then((response) => console.log(response.states));

Frontend Example | NodeJs Example

πŸ“š Documentation

πŸ‘₯ Contributors

This project is maintained by Raed Chammam.

This project is considered stable but not in active development. If you encounter a problem, create an issue and I will respond with best effort.

Raed Chammam
Raed Chammam

πŸ’» ⚠️ πŸ“– πŸš‡
Clint
Clint

πŸ’»

πŸ“œ License

GPL-3.0

Generated using TypeDoc