These sections detail the external (i.e. REST/Websocket) as well as the internal (i.e. Classes/Functions) API of Weacast.

You might read this introduction article about using Feathers in production because it has been used as a guideline for the development Weacast.


All dates/times in Weacast are managed as moment objects and expressed in UTC.


You will find here a collection of ready-to-go REST requests to test the API with the great POSTMAN tool. Simply download it and import it in your POSTMAN installation.

You should do the following:

  1. make your Weacast installation run (the collection is configured for default dev port 8080 but you can easily switch to 8081 for production mode for instance or any other)
  2. use the authenticate request with a registered user e-mail/password to retrieve an authorization token
  3. set this token in the header of other requests in order to be authorized to perform the request
  4. renew your token when expired (step 2)