Skip to content

Update README.md#206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ivanstan merged 1 commit into from
Jun 5, 2021
Merged

Update README.md #206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# TLE API

[![build](https://travis-ci.com/ivanstan/tle-api.svg?branch=master)](https://travis-ci.com/ivanstan/tle-api)
<!-- [![build](https://travis-ci.com/ivanstan/tle-api.svg?branch=master)](https://travis-ci.com/ivanstan/tle-api) -->
<!-- ![dependabot](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot) -->
![coverage](https://badgen.net/coveralls/c/github/ivanstan/tle-api)
![dependabot](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)
![status](https://badgen.net/uptime-robot/status/m781499721-d42767e28cc71aea507fb087)
![status](https://badgen.net/uptime-robot/month/m781499721-d42767e28cc71aea507fb087)
![status](https://badgen.net/uptime-robot/response/m781499721-d42767e28cc71aea507fb087)
Expand All@@ -14,20 +14,18 @@ API provides up to date two line element set records, the data is updated
daily from [CelesTrak](https://celestrak.com/) and served in JSON format. A two-line element set (TLE)
is a data format encoding a list of orbital elements of an
Earth-orbiting object for a given point in time.
For more information on TLE data format visit [Definition of
Two-line Element Set Coordinate System](https://spaceflight.nasa.gov/realdata/sightings/SSapplications/Post/JavaSSOP/SSOP_Help/tle_def.html).

## Usage
Further documentation and response examples are available at:
http://tle.ivanstanojevic.me/api/tle/docs
https://tle.ivanstanojevic.me/

###Available endpoints
###Available endpoints
The TLE API consists of two endpoints `GET http://tle.ivanstanojevic.me`

| Endpoint | Description |
|----------|:------:|
| `GET /api/tle?search={q}` | Perform search by satellite name |
| `GET /api/tle/{q}` | Retrieve a single TLE record where query is satellite number |
| `GET /api/tle?search={query}` | Perform search by satellite name |
| `GET /api/tle/{id}` | Retrieve a single TLE record where id is satellite number |

Example query
http://tle.ivanstanojevic.me/api/tle
Expand Down