48 lines
2.2 KiB
ReStructuredText
48 lines
2.2 KiB
ReStructuredText
.. The OpenSky Network API documentation master file, created by
|
|
sphinx-quickstart on Tue Mar 1 19:48:21 2016.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
The OpenSky Network API documentation
|
|
=====================================
|
|
|
|
This is the official documentation of the OpenSky Network's live API. The API lets you retrieve live airspace information for research and non-commerical purposes.
|
|
|
|
Please note that the API does not provide commmercial flight data such as airport schedules, delays or similar information that cannot be derived from ADS-B data contents!
|
|
|
|
Information is generally provided in the form of *State Vectors* (see below). The following paragraphs will help you understand how we represent an aircraft's state and how to use it. There is also a little more specific documentation available for our :doc:`REST API <rest>`. We provide a :doc:`Python <python>` language binding and a :doc:`Java <java>` language binding for the REST API.
|
|
|
|
Citation and Terms of Use
|
|
---------------
|
|
|
|
If you create a publication (including web pages, papers published by a third party, and publicly available presentations) using data from the OpenSky Network data set, you should cite the original OpenSky paper as follows::
|
|
|
|
Matthias Schäfer, Martin Strohmeier, Vincent Lenders, Ivan Martinovic and Matthias Wilhelm.
|
|
"Bringing Up OpenSky: A Large-scale ADS-B Sensor Network for Research".
|
|
In Proceedings of the 13th IEEE/ACM International Symposium on Information Processing in Sensor Networks (IPSN), pages 83-94, April 2014.
|
|
|
|
You can additionally mention our URL, where appropriate::
|
|
|
|
The OpenSky Network, https://opensky-network.org
|
|
|
|
See our `terms and conditions <https://opensky-network.org/about/terms-of-use>`_ for more details on the data license model. If you want to retrieve live flight information for commercial purposes, please `contact us <https://opensky-network.org/about/contact>`_.
|
|
|
|
|
|
.. _state-vectors:
|
|
|
|
.. include:: state-vectors.rst
|
|
|
|
|
|
Further Reading
|
|
---------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Intro & Data Structures <self>
|
|
REST API <rest>
|
|
Python API <python>
|
|
Java API <java>
|
|
|
|
|