BETA. Beta resources may undergo minor revisions and may not have the benefit of complete documentation.
Description
Returns current weather data for a postal code.
Our patented OnPoint™ system uniquely derives data for every postal code location. This resource is available for U.S. and Canadian postal codes.
Requires a subscription plan with the “read_nowcast” and “access_postal_codes” capabilities to access this resource.
This resource is available to free 30-day developer plans. For access to this resource for longer than 30 days, or for licensed use of the API in production environments, please email sales@weathersource.com or call (844) 813-2617.
Resource URL
https://api.weathersource.com/v1/{{api_key}}/postal_codes/{{postal_code}},{{country}}/nowcast.{{format}}
Resource URL Replacement Parts
{{api_key}} | Your API Key. If you do not have an API key, you may sign up for a free developer account 30-day trial. |
---|---|
{{postal_code}} | A postal code value (e.g. 22222). Any spaces in the postal code must be URL encoded as %20. For example, the Canadian postal code "X0A 0K0" would be passed as X0A%200K0. More than 5.5 million postal codes are supported globally. |
{{country}} | A supported 2-character ISO 3166-1 Alpha-2 country code. Postal code support is available for 151 countries. |
{{format}} | The desired response format. Allowed formats are:
|
Parameters
fields optional |
Set response to a subset of fields within each element. For fastest response times, limit the fields to those required. Available field names: The weather data fields:
Field groups: Allowed Values: Comma separated list of field names Default Value: all |
---|
Resource Information
API Versions | v1 |
---|---|
Rate Limited? | Yes |
Requires Authentication? | Yes |
Response Formats | JSON JSONP CSV |
HTTP Method | GET |
Related Documentation
Example Request
GET https://api.weathersource.com/v1/{{api_key}}/postal_codes/22222,us/nowcast.json?fields=allMeta,temp
{"postal_code":"22222","country":"US","timestamp":"2017-06-29T14:54:12-04:00","temp":88.3}