1
0
Fork 0
satnogs-db/docs/api.rst

27 lines
765 B
ReStructuredText
Raw Normal View History

2017-03-13 11:15:06 -06:00
API
===
SatNOGS DB API is a REST API that provides detailed information about Satellites and Transmitters.
This document explains how to use the API to retrieve data for your application.
2017-03-13 11:15:06 -06:00
Using API Data
--------------
API access is open to anyone.
All API data are freely distributed under the `CC BY-SA <https://creativecommons.org/licenses/by-sa/4.0/>`_ license.
Python API Client
-----------------
A Python client package is automatically generated for each release.
The package is named ``satnogs-db-api-client``.
This Python client is available in `PyPI <https://pypi.org/project/satnogs-db-api-client/>`_.
2017-03-13 11:15:06 -06:00
API Reference
-------------
2017-03-13 11:15:06 -06:00
`Our live schema docs <https://db.satnogs.org/api/schema/docs/>`_ contain a full interactive reference of the API.