Skip to content

LindseyB/moon-api

Repository files navigation

Moon API

Requests

GET / [run]

Returns the current moonphase

GET /phases/[phase] [run]

Possible phases: new, waxing_crescent, first_quarter, waxing_gibbous, full, waning_gibbous, last_quarter, waning_crescent

Returns the information for the specified phase

GET /date/[unix timestamp] [run]

Returns the phase for the given date

Phase data shape

field type description
phase string one of new, waxing_crescent, first_quarter, waxing_gibbous, full, waning_gibbous, last_quarter, waning_crescent
days integer number of days in this moon phase - always 0 for date and phase endpoints
emoji emoji one of 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘
association string magical association for this phase

GET /phases [run]

Returns an array of all the possible phases of the moon and associated data.

Example payload

{
  "phase": "waxing_crescent",
  "days": 2,
  "emoji": "🌒",
  "association": "setting intentions"
}

Testing

bundle exec rake test

Getting Started

bundle install
bundle exec rackup

Deploying

Deploying is just merging now that I'm hosting on Render, worth it IMO to keep the APP patched and live without having to write my own deployment pipeline for a hobby app.

About

RESTful API for the Moon

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •  

Languages