From 735f704916f4ce7ebf67c332ebf00a10c4eea195 Mon Sep 17 00:00:00 2001 From: Emile Date: Thu, 5 Sep 2019 19:12:05 +0200 Subject: started definig the api --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b119aba..b1eeefd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ # TLE2JSON -http api returning TLEs as json \ No newline at end of file +http api returning TLEs as json + +## API + + +### endpoints + +The api will eventually consist of the following endpoints. There is currently +no guarantee that the enpoins will stay like this, this is really early alpha +and may change alot in the next days / weeks: + +- `/v1/getall` + - returns all TLEs +- `/v1/regex/{regex}` + - returns all the TLEs matching the given `regex` +- `/v1/satid/{satid}` + - returns all the TLEs with the given `satid` +- `/v1/category/{category}` + - returns all the TLEs from the named category + - (the categories are the ones given [here](https://celestrak.com/NORAD/elements/)) +- `/v1/category/{category}/satname/{satname}` + - returns the TLE of the satellite in the given `category` with the given + `satname` + +### parameters + +- `?format=json` + - returns the TLEs as json objects +- `?format=raw` + - returns the TLE in the raw Two-Line format +- `?values=inclination,argumentofperigee` + - returns the values given as a comma, seperated list of arguments -- cgit 1.4.1