Understanding the User-Agent requirement
The National Weather Service API is open data, free to use, and has no accounts, sign-up, or API keys. Instead of a secret credential, every request must carry a User-Agent header that identifies the application making it, as described in the NWS API authentication documentation.
- There is no provider portal to visit and nothing to generate — you choose this value yourself.
- The NWS requires it because of a high number of scripts exhibiting abusive behavior, and uses it to contact you if it notices unusual traffic.
- Note: The NWS documentation states that this mechanism will be replaced with an API key at a later date.
Choose your User-Agent value
Compose a single string that names your application and gives the NWS a way to reach you, then enter it in the User-Agent field in StackOne Hub.
- Format:
(yourdomain.com, contact@yourdomain.com) - Example:
(myweatherapp.com, contact@myweatherapp.com) - The string can be anything, but the more unique it is to your application, the less likely it is to be affected by a security event.
- Use a contact address you actually monitor — the NWS uses it to reach you if your string is associated with a security event.
- No rate limits or access levels are tied to the value you choose — the API is free and open regardless of what you enter.
Linking the Account from the Hub
1
Navigate to the Hub
Use one of the three Linking Account Methods to access the Hub.
2
Fill out the fields
Fill out the following fields using details from your provider:
- User-Agent
3
Connect
- Click Connect
- If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
- Once authorization is successful, you will see a confirmation popup
If the account linking is successful, you will see the newly linked account in your Accounts page.