{"id":39178628,"url":"https://github.com/observerly/nocturnal","last_synced_at":"2026-01-17T22:31:27.436Z","repository":{"id":37043847,"uuid":"482818625","full_name":"observerly/nocturnal","owner":"observerly","description":"🌑 Nocturnal is observerly's Gin Gonic API for Lunar and Solar advanced scheduling, that utilises Dusk.","archived":false,"fork":false,"pushed_at":"2023-06-02T23:11:55.000Z","size":145,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-06-21T11:25:20.537Z","etag":null,"topics":["amateur-astronomy","astronomy","dawn","dusk","lunar","night","solar","twilight"],"latest_commit_sha":null,"homepage":"https://nocturnal.observerly.com/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/observerly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-18T11:16:47.000Z","updated_at":"2023-06-21T06:19:31.000Z","dependencies_parsed_at":"2024-06-21T10:24:39.676Z","dependency_job_id":"56a7a4b9-9c50-4c56-998e-5afb8178b110","html_url":"https://github.com/observerly/nocturnal","commit_stats":{"total_commits":105,"total_committers":3,"mean_commits":35.0,"dds":0.01904761904761909,"last_synced_commit":"fde2c6af8505f5559778999e1137fa687b8e812b"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/observerly/nocturnal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/observerly%2Fnocturnal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/observerly%2Fnocturnal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/observerly%2Fnocturnal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/observerly%2Fnocturnal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/observerly","download_url":"https://codeload.github.com/observerly/nocturnal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/observerly%2Fnocturnal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28520705,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T22:11:28.393Z","status":"ssl_error","status_checked_at":"2026-01-17T22:11:27.841Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amateur-astronomy","astronomy","dawn","dusk","lunar","night","solar","twilight"],"created_at":"2026-01-17T22:31:22.633Z","updated_at":"2026-01-17T22:31:27.428Z","avatar_url":"https://github.com/observerly.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![@observerly:nocturnal](https://user-images.githubusercontent.com/84131395/174099920-eda972ff-2493-4eea-b572-e31394cd0d36.jpg)\n\nNocturnal 🌑 is observerly's Gin Gonic API for Lunar and Solar advanced scheduling, that utilises [Dusk](https://github.com/observerly/dusk), available at https://nocturnal.observerly.com as a highly performant public API. \n\nThe Nocturnal API is designed to be stateless, and to return a response based on the current time, and the parameters passed to the API.\n\nPlease note, the specifics of the Nocturnal API is currently in active development, and is subject to without warning.\n\n## Usage\n\n### Introduction\n\nAs mentioned, the Nocturnal API is designed to be stateless. That is, a request to the API will return a response based on the current time, and the parameters passed to the API. \n\nThis means that the API can be used to understanding the position of the Moon, the Sun, or any transiting body (e.g., a Star) at any time in the past, present, or future.\n\n### Schema\n\nThe Nocturnal base URL for the API will be {HOST}/api/v2/ where {HOST} is the host name of the API, e.g., https://nocturnal.observerly.com.\n\nThere is a deprecate version of the API, but as of 14.02.2023 we do not recommend its use. The deprecate version of the API is available at {HOST}/api/v1/ where {HOST} is the host name of the API, e.g., https://nocturnal.observerly.com.\n\nThe Nocturnal API has a standardised API JSON response format, which adheres to the [JSON API](https://jsonapi.org/) specification as well as the schema defined in the [OpenAPI](https://swagger.io/specification/) specification.\n\nFor Sun, Moon and Transit endpoints, the API JSON response adheres to the following schema:\n\n```json\n{\n  \"observer\": {\n    \n  },\n  \"rise\": {\n\n  },\n  \"maximum\": {\n\n  },\n  \"set\": {\n\n  },\n}\n```\n\nFor Twilight endpoints, the API JSON response adheres to the following schema:\n\n```json\n{\n  \"observer\": {\n    \n  },\n  \"civil\": {\n\n  },\n  \"nautical\": {\n\n  },\n  \"astronomical\": {\n\n  },\n}\n```\n\n### API Endpoints\n\nThe Nocturnal API has the following endpoints:\n\n- [GET /api/v2/sun](#get-apiv2sun)\n\n- [GET /api/v2/moon](#get-apiv2moon)\n\n- [GET /api/v2/transit](#get-apiv2transit)\n\n- [GET /api/v2/twilight](#get-apiv2twilight)\n\n## API Development\n\n### Project Requirements\n\nWe welcome any and all contributions or raised issues to this repository.\n\nTo contribute to this project, you will need the following tools installed on your local machine:\n\n- [Docker](https://www.docker.com/).\n- [Docker Compose](https://docs.docker.com/compose/install/).\n- [Go](https://go.dev/dl/) version 1.17+ (or later).\n\n### Local Development\n\nThe Nocturnal development stack can be built with the following `docker` `compose` command:\n\n```console\n$ docker compose -f local.yml build\n```\n\nThe Nocturnal development stack can then be started with:\n\n```console\n$ docker compose -f local.yml up\n```\n\nor simply by utilising the following combined command:\n\n```console\ndocker compose -f local.yml up --build\n```\n\n### Testing\n\nThe Nocturnal development stack can be tested with the following command:\n\n```console\nGIN_MODE=release bash -c \"go test ./... -race -coverprofile=coverage.txt -covermode=atomic -v\"\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobserverly%2Fnocturnal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fobserverly%2Fnocturnal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobserverly%2Fnocturnal/lists"}