Getting started

API keys

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

Create an account and request a free trial API key. For full commercial access, contact data@windbornesystems.com.
Store your API key — you'll use it to authenticate every request.
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.

curl 'URL' -H "Authorization: Bearer $WB_API_KEY"curl 'URL' -H "Authorization: Bearer $WB_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.

pip3 install windbornepip3 install windborne

Test API call

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

curl 'https://api.windbornesystems.com/debug/v1/auth_status' -H "Authorization: Bearer $WB_API_KEY"curl 'https://api.windbornesystems.com/debug/v1/auth_status' -H "Authorization: Bearer $WB_API_KEY"

Example successful response

content-type: application/json

1 {{

2 "authed": true "authed": true

3 }}

Example error response

Authentication Error

content-type: application/json

1 {{

2 "error": "Not authorized", "error": "Not authorized",

3 "success": false "success": false

4 }}