Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raed667/opensky-api

Library wrapper for OpenSky’s REST API written in TypeScript
https://github.com/raed667/opensky-api

api opensky opensky-api opensky-network openskynetwork rest rest-api

Last synced: 2 months ago
JSON representation

Library wrapper for OpenSky’s REST API written in TypeScript

Host: GitHub
URL: https://github.com/raed667/opensky-api
Owner: raed667
License: mit
Created: 2022-04-10T16:10:41.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-01-30T08:55:31.000Z (11 months ago)
Last Synced: 2024-10-09T17:53:48.578Z (3 months ago)
Topics: api, opensky, opensky-api, opensky-network, openskynetwork, rest, rest-api
Language: TypeScript
Homepage: https://www.npmjs.com/package/opensky-api
Size: 377 KB
Stars: 8
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # OpenSky

[![Quality Check](https://github.com/raed667/opensky-api/actions/workflows/ci.yml/badge.svg)](https://github.com/raed667/opensky-api/actions/workflows/ci.yml)

[![Stability: Stable](https://img.shields.io/badge/stability-stable-brightgreen.svg)](https://raed667.github.io/opensky-api/globals.html)

[![npm](https://img.shields.io/npm/v/opensky-api)](https://www.npmjs.com/package/opensky-api)

[![codecov](https://codecov.io/gh/raed667/opensky-api/branch/main/graph/badge.svg?token=NDV86JJG7V)](https://codecov.io/gh/raed667/opensky-api)

[![npm bundle size](https://img.shields.io/bundlephobia/minzip/opensky-api)](https://www.npmjs.com/package/opensky-api)

[![npm downloads](https://img.shields.io/npm/dt/opensky-api)](https://www.npmjs.com/package/opensky-api)

[![LICENSE](https://img.shields.io/npm/l/opensky-api)](https://github.com/raed667/opensky-api/blob/main/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](https://openskynetwork.github.io/opensky-api/index.html).

This project is not affiliated to [OpenSky Network](https://github.com/openskynetwork), but the codebase is heavily inspired by the [opensky-api](https://github.com/openskynetwork/opensky-api) Java implementation.

## 📦 Install

```sh

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`

```ts

import { OpenSkyApi } from 'opensky-api';

const api = OpenSkyApi();

api

  .getStates(1458564121, ['3c6444'])

  .then((response) => console.log(response.states));

```

[Frontend Example](https://codesandbox.io/s/stoic-keldysh-y0mj7o?file=/src/App.js) | [NodeJs Example](https://codesandbox.io/s/billowing-glitter-l2nj36?file=/routes/index.js)

## 📚 Documentation

- [OpenSkyJS](https://raed667.github.io/opensky-api/)

- [OpenSky REST](https://openskynetwork.github.io/opensky-api/rest.html)

## 👥 Contributors

This project is maintained by [Raed Chammam](https://raed.dev).

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}
💻 ⚠️ 📖 🚇

      
_Clint
💻

    

  

## 📜 License

[GPL-3.0](LICENSE)