Giter Club home page Giter Club logo

sky-tonight-api's Introduction

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

sky-tonight-api's People

Contributors

wwwescape avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.