Documentation

Welcome to the Windy PWS (Personal Weather Stations) project! This documentation walks you through managing your personal weather station—from setup to data uploads. Whether you're here for instructions for your station brand or to contribute to our growing list of supported devices, you're in the right place.

Introduction

This project helps you manage personal weather stations with an interface for creating, reading, updating, and deleting station records. You can also upload weather data via an API to keep your station up to date.

If you're unsure where to start, search for your weather station brand in our list of supported devices. If there's no guide for your brand, try the process yourself and share what you learn by opening a pull request in the PWS GitHub repository .

Getting started

  1. Setting Up Your Weather Station
    • Create an Account: If you already have one, sign in; otherwise create an account on our platform to manage stations and access the API.
    • Add a Station: After your account is ready, go to My Stations and add a station. Fill in the required details such as station name, location, and brand. You can promote yourself by filling in the operator data. It will be shown on Windy.com along with the station data.
  2. Managing Your Stations
    • View, Edit, and Delete Stations: Access a list of all your stations with options to view details for each one.
  3. Uploading Weather Data

    Upload weather data to our platform using the RESTful API. To accept data, the API requires authentication via a station password.

    • Get station password: After creating a station, find the password in the station details in My Stations.
    • Send Data: Use the API endpoint for updating observations to upload your station's data. See API Reference (Observations) for details. Make sure the data matches the required format and you include the station password.
  4. Viewing Data

    Once your data is uploaded, you can view it in real-time on windy.com. The link is in the station detail in My Stations.

    Note:

    After you create a station, there can be a delay of up to 15 minutes before it appears on the map. Any data sent during this time will be lost.

  5. Manage stations programmatically

    Actions around stations (create, remove, edit, list, get info) can be handled manually in My Stations. For automation, use the API. All actions are secured with API key authentication.

    • Get API key: Generate a new API key or reuse an existing one in API Keys. We strongly recommend different API keys for different actions.
    • Handle requests: Use the API endpoints for managing your stations. See API Reference (PWS) for details. Ensure your API key is included.
  6. Fetching open data stations

    All Open data stations can be fetched via API. Users can choose whether their stations are published under an open license. If open, both metadata and observations are available. Requests require an API key.

    • Get API key: Generate a new API key or reuse an existing one in API Keys. We strongly recommend different API keys for different actions.
    • Handle requests: Use the API endpoints to list or get observations of Open data stations. See API Reference (Open data stations) for details. Ensure your API key is included.

Contributing

We welcome contributions from the community! If you have a weather station that's not listed, or if you have improvements to suggest for our existing guides, please share your work with us.

How to Contribute

  1. Fork the Repository: Start by forking the PWS GitHub repository
  2. Add Your Guide: Create a new markdown file for your weather station brand under the appropriate directory, following the format of existing guides.
  3. Submit a Pull Request: Once your guide is ready, submit a pull request. Our team will review your submission and merge it into the main project.

List of supported devices

Cumulus

Spotted a bug or an inconsistency? Have an idea for improvement? Drop us a note on the Windy Community. Your feedback helps us improve.