Getting Started with Weatherwise
Welcome to the Weatherwise API! Our platform empowers you to schedule high-resolution weather simulation forecasts and hindcasts on-demand. This guide will walk you through the fundamental concepts and steps to get you started.
1. Authentication
To use the Weatherwise API, you’ll need an API key. Please contact our team at contact@weatherwise.fr to request your key.
All API requests must be authenticated using your API token in the X-API-KEY header.
X-API-KEY: YOUR_API_KEY2. API Health Check
The REST API base URL is https://api.weatherwise.fr.
You can check the connectivity and health of the API by making a request to the /health endpoint, which is open and does not require authentication.
curl https://api.weatherwise.fr/health3. Core Concepts
The Weatherwise API allows you to run powerful weather simulations tailored to your specific needs.
Simulation Models
You can initiate simulations using data from leading global weather models or historical datasets (hindcasts).
- Forecast Models: GFS, IFS (HRRR and more coming soon!)
- Hindcast Models: ERA5
Location and Resolution
Specify the precise area for your simulation using latitude and longitude coordinates. You can define the resolution of the output, with a minimum grid spacing of 200m x 200m, allowing for hyperlocal forecasts with fine scale processes to be explicitely resolved.
4. Your First Simulation: A Workflow Overview
Using the Weatherwise API follows a simple workflow.
- Creating Your First Simulation: Learn how to structure your API request to schedule a new forecast or hindcast run.
- Confirming Your Simulation: Understand the response you get after a successful request.
- Checking on Simulation Status: Poll the API to monitor the progress of your simulation.
- Downloading Simulation Outputs: Once your simulation is complete, find out how to download the resulting data.
5. API Reference
For a complete overview of all available endpoints, parameters, and schemas, please visit our API Reference.