Getting started

Getting started

API keys

Before you can access WindBorne's weather data, you'll need to obtain API keys.

  1. Create an account and request a free trial API key. For full commercial access, contact data@windbornesystems.com.
  2. Store your API key — you'll use it to authenticate every request.
  3. Make a test call (see below) to confirm everything works.

Free trial

The free trial gives you access to all Forecast and Insights endpoints for 2 weeks, with a limit of 5 requests per minute and 2,000 total requests. Data endpoints (observations, soundings, and mission metadata) require a paid API key. Once you run out, you can request an extension from your API tokens page.

Bearer token authentication

WindBorne uses Bearer token authentication. You can authenticate your requests using your API key.

CLI and Python library

WindBorne releases a pip installable library built to interact with Data and Forecasts APIs that comes with a Command Line Interface (CLI) out of the box.

Test API call

Let's test your authentication by making a call to the auth_status endpoint.

Example successful response

OK
content-type: application/json

Example error response

Authentication Error
content-type: application/json

Get interpolated forecast

Fetch temperature_2m from wm-6 at a single lat/lon with include_distribution=true to get distribution outputs such as ensemble mean, standard deviation, and percentiles. See the Interpolated point forecast endpoint for all parameters.

Get gridded forecast

Download the global wm-6 grid for temperature_2m at one forecast time as a Zarr archive (the default format for wm-6 ), with include_distribution=true for distribution outputs. See the Gridded forecast endpoint for all parameters.