Getting started
API keys
Before you can access WindBorne's weather data, you'll need to obtain API keys. Only the forecast endpoints and endpoints providing metadata are free to use.
You can get your API keys here and learn more about authentication here.
Basic authentication
WindBorne uses HTTP Basic Authentication. You can authenticate your requests using your client ID and API key.
curl -u 'WB_CLIENT_ID:WB_API_KEY' 'URL'curl -u 'WB_CLIENT_ID:WB_API_KEY' 'URL'
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 -u 'WB_CLIENT_ID:WB_API_KEY' 'https://api.windbornesystems.com/debug/v1/auth_status'curl -u 'WB_CLIENT_ID:WB_API_KEY' 'https://api.windbornesystems.com/debug/v1/auth_status'
Example successful response
OK
content-type: application/json
1 {{
2 "client_id": "WB_CLIENT_ID", "client_id": "WB_CLIENT_ID",
3 "authed": true "authed": true
4 }}
Example error response
Authentication Error
content-type: application/json
1 {{
2 "error": "Not authorized", "error": "Not authorized",
3 "success": false "success": false
4 }}