Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicorobo/telescope
An API for the sky.
https://github.com/nicorobo/telescope
Last synced: about 1 month ago
JSON representation
An API for the sky.
- Host: GitHub
- URL: https://github.com/nicorobo/telescope
- Owner: nicorobo
- Created: 2016-01-26T03:56:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-01T07:19:00.000Z (almost 9 years ago)
- Last Synced: 2023-10-15T10:12:37.797Z (about 1 year ago)
- Language: JavaScript
- Size: 13 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Telescope
An API for the sky.
Telescope provides access to information on over 15,000 stars, and all 88 constellations.
Of course there are many, many more stars in space, but Telescope only
provides information for stars with a **magnitude of less than 7**.
### API
-----
#### `/stars`
A `GET` request to this endpoint will return JSON defining stars. Here is an example:
```javascript
{
"count": 15588, // A count of stars that match this query in the database
"stars": {
32263: {
"id": 32263, // The star's ID in David's HYG database.
"bf": "9Alp CMa", // The Bayer/Flamsteed designation, if known.
"hd": 48915, // The star's ID in the Henry Draper catalog, if known.
"con": "CMa", // The star's constellation.
"dec": -16.716116, // The star's declination.
"ra": 6.752481, // The star's right ascension.
"dist": 2.6371, // The star's distance from Earth in light years.
"incon": true, // True if star is in a symbolic constellation.
"mag": -1.44, // The star's apparent visual magnitude.
"proper": "Sirius", // The star's common name, if known.
},
// ...
}
}
```
Example Query: `/stars?limit=20&page=2&con=Ori&mag=3&magparam=gt`
*(This will return JSON for stars 11-20 in the constellation of Orion that have a magnitude greater than 3)*
*(Stars are ordered by magnitude in ascending order)*
#### Options
Query | Example | Explanation | Default
----|----|----|----
`limit`|`?limit=20`|Limit the number of stars in the response.| 50
`page`|`?page=2`|Define what page you want back.|1
`con`|`?con=Ori`|Filter the stars by their constellation.|All
`mag`|`?mag=3`|Filter the stars by their magnitude.|All
`magparam`|`?magparam=gt`|Changes how the mag query is interpreted.|lt
`search`|`?search=18Alp%20Cas`|Performs a text search.| *none*
-----
#### `/constellations`
**(Now we're talking about symbolic constellations)**
A `GET` request to this endpoint will return JSON defining constellations. Here is an example:
```javascript
{
"Tau": {
"abbr": "Tau", // The abbreviation of the constellation.
"name": "Taurus", // The full name of the constellation.
"meaning": "The Bull", // The meaning of the constellation's symbol.
"content": "Taurus is a ...", // A snippet of text that goes along with the constellation.
"stars": { // An object of all the stars in the constellation.
32263: {
// See the above description of star objects.
},
// ...
},
"connections": [ // An array of all the lines connecting stars in the constellation.
[32263, 32265], // The IDs of two connected stars.
[32265, 1322],
[1322, 53338],
// ...
]
},
// ...
}
```
Example Query: `/constellations?con=Tau`
*(This will return JSON for the constellation of Taurus)*
#### Options
Query | Example | Explanation | Default
----|----|----|----
`con`|`?con=Tau`|Select a single constellation|*none*
*(`?con` takes a constellation abbreviation, [here is a good list of them](https://en.wikipedia.org/wiki/88_modern_constellations))*