Skip to content

wwwescape/sky-tonight-api

Repository files navigation

Sky Tonight API

GH-release GH-last-commit GH-code-size hacs_badge Codecov Coverage CodeFactor

Get list of visible planetary bodies in your sky.

A free JSON API powered by Don Cross' JS Astronomy Engine.

Run

npm install
npm start

Remember to update volume path, port and timezone as needed.

Running using Docker compose

docker compose up -d

Remember to update volume path, port and timezone as needed.

Usage

Get a list of planets, the sun and the moon above the horizon.

GET https://{IP Address or Domain with/without port}?latitude=32&longitude=-98

Get a list of planets, the sun and the moon with their declination and right ascension coordinates.

GET https://{IP Address or Domain with/without port}?latitude=32&longitude=-98&showCoords=true

Query Parameters

Param Default Description
latitude 28.627222 Latitude of the observer
longitude -80.620833 Longitude of the observer
elevation 0 Elevation of the observer in meters above sea level
time null Time of observation in ISO 8601 format, defaults to time of request
showCoords false Display declination and right ascension of each body, expects true or false
aboveHorizon true Set to false to display all planetary bodies even if they are below the horizon

TODO

  • Reduce the size of the Docker image created
  • Fix issue with Node not picking up the correct timezone from the Docker container

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published