Skip to content

API Quickstart Guide

Jussi Saarivirta edited this page Jan 21, 2023 · 6 revisions

Installing watney-api

First thing to do is to download the API app.

Current release: v1.2.0

Download (Windows, Linux, OSX)

Choose the correct package for your OS and architecture.


Next you will need a catalog star quad database to go with the app.

Download from releases

The pre-built quad database has been split into multiple smaller downloads. Depending on your telescope setup you'll need to download one or more files. The properties of each database file set are explained in the wiki; in short, the files cover different field radius ranges.


Extract the solver to any directory you want, and the quad database files to another directory. Configure your solver by editing the config.yml text file, set the path to the quad database directory there.

By editing the configuration file you can also enable/disable and configure authentication, enable/disable astrometry.net compatibility API, persistence (writing jobs to disk) and so on. These are explained in more detail here.