openapi-directory/api/weatherbit.io.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"x-twitter":"weatherbitio"},"description":"This an interactive version of the documentation for the Weatherbit API.  The base URL for the API is [http://api.weatherbit.io/v2.0/](http://api.weatherbit.io/v2.0/) or [https://api.weatherbit.io/v2.0/](http://api.weatherbit.io/v2.0/). Below is the Swagger UI documentation for the API. All API requests require the `key` parameter.        An Example for a 48 hour forecast for London, UK would be `http://api.weatherbit.io/v2.0/forecast/hourly?lat=51.5072`&`lon=-0.1276`. See our [Weather API description page](https://www.weatherbit.io/api) for the full documentation.","title":"Weatherbit - Interactive Swagger UI Documentation","version":"2.0.0","x-apisguru-categories":["location"],"x-logo":{"url":"https://twitter.com/weatherbitio/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://www.weatherbit.io/static/swagger.json","version":"2.0"}],"x-providerName":"weatherbit.io"},"paths":{"/alerts?lat={lat}&lon={lon}":{"get":{"description":"Returns severe weather alerts issued by meteorological agencies - given a lat, and a lon.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Weather Alert Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherAlert"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns severe weather alerts issued by meteorological agencies - Given a lat/lon.","tags":["Alerts"]}},"/bulk/files/{file}":{"get":{"description":"Downloads bulk data files - OPTIONS: ( current.csv.gz, forecast_hourly.csv.gz, forecast_daily.csv.gz). Units are Metric (Celcius, m/s, etc).","parameters":[{"description":"Filename (ie. current.csv.gz)","in":"path","name":"file","required":true,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Download pre-generated bulk datasets","tags":["Bulk Downloads"]}},"/current/airquality?city={city}&country={country}":{"get":{"description":"Returns current air quality conditions.","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Current air quality conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQCurrentGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns current air quality conditions - Given City and/or State, Country.","tags":["Current Air Quality"]}},"/current/airquality?city_id={city_id}":{"get":{"description":"Returns current air quality conditions.","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Current air quality conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQCurrentGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns current air quality conditions - Given a City ID.","tags":["Current Air Quality"]}},"/current/airquality?lat={lat}&lon={lon}":{"get":{"description":"Returns current air quality conditions.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Current air quality conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQCurrentGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns current air quality conditions - Given a lat/lon.","tags":["Current Air Quality"]}},"/current/airquality?postal_code={postal_code}":{"get":{"description":"Returns current air quality conditions.","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Current air quality conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQCurrentGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns current air quality conditions - Given a Postal Code.","tags":["Current Air Quality"]}},"/current?cities={cities}":{"get":{"description":"Returns a group of Current Observations - Given a list of City IDs. ","parameters":[{"description":"Comma separated list of City ID's. Example: 4487042, 4494942, 4504871","in":"path","name":"cities","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a group of observations given a list of cities","tags":["Current Weather Data"]}},"/current?city={city}&country={country}":{"get":{"description":"Returns a Current Observation - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Include 1 hour - minutely forecast in the response","in":"query","name":"include","required":false,"schema":{"type":"string","format":"string","enum":["minutely"]}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a Current Observation - Given City and/or State, Country.","tags":["Current Weather Data"]}},"/current?city_id={city_id}":{"get":{"description":"Returns current weather observation - Given a City ID. ","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Include 1 hour - minutely forecast in the response","in":"query","name":"include","required":false,"schema":{"type":"string","format":"string","enum":["minutely"]}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a current observation by city id.","tags":["Current Weather Data"]}},"/current?lat={lat}&lon={lon}":{"get":{"description":"Returns a Current Observation - given a lat, and a lon.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Include 1 hour - minutely forecast in the response","in":"query","name":"include","required":false,"schema":{"type":"string","format":"string","enum":["minutely"]}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a Current Observation - Given a lat/lon.","tags":["Current Weather Data"]}},"/current?points={points}":{"get":{"description":"Returns a group of Current Observations - Given a list of points (lat1, lon1), (lat2, lon2), (latN, lonN), ...","parameters":[{"description":"Comma separated list of points. Example: (35.5, -75.5),(45, 65),(45.12, -130.5)","in":"path","name":"points","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a group of observations given a list of points in the format (lat1, lon1), (lat2, lon2), (latN, lonN), ...","tags":["Current Weather Data"]}},"/current?postal_code={postal_code}":{"get":{"description":"Returns current weather observation - Given a Postal Code. ","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Include 1 hour - minutely forecast in the response","in":"query","name":"include","required":false,"schema":{"type":"string","format":"string","enum":["minutely"]}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a current observation by postal code.","tags":["Current Weather Data"]}},"/current?station={station}":{"get":{"description":"Returns a Current Observation - Given a station ID.","parameters":[{"description":"Station Call ID.","in":"path","name":"station","required":true,"schema":{"type":"string","format":"string"}},{"description":"Include 1 hour - minutely forecast in the response","in":"query","name":"include","required":false,"schema":{"type":"string","format":"string","enum":["minutely"]}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a Current Observation. - Given a station ID.","tags":["Current Weather Data"]}},"/current?stations={stations}":{"get":{"description":"Returns a group of Current Observations - Given a list of Station Call IDs. ","parameters":[{"description":"Comma separated list of Station Call ID's. Example: KRDU,KBFI,KVNY","in":"path","name":"stations","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a group of observations given a list of stations","tags":["Current Weather Data"]}},"/forecast/airquality?city={city}&country={country}":{"get":{"description":"Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of hours to return.","in":"query","name":"hours","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns 72 hour (hourly) Air Quality forecast - Given City and/or State, Country.","tags":["Air Quality Forecast"]}},"/forecast/airquality?city_id={city_id}":{"get":{"description":"Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of hours to return.","in":"query","name":"hours","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns 72 hour (hourly) Air Quality forecast - Given a City ID.","tags":["Air Quality Forecast"]}},"/forecast/airquality?lat={lat}&lon={lon}":{"get":{"description":"Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}},{"description":"Number of hours to return.","in":"query","name":"hours","required":false,"schema":{"type":"integer","format":"integer"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns 72 hour (hourly) Air Quality forecast - Given a lat/lon.","tags":["Air Quality Forecast"]}},"/forecast/airquality?postal_code={postal_code}":{"get":{"description":"Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of hours to return.","in":"query","name":"hours","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns 72 hour (hourly) Air Quality forecast - Given a Postal Code.","tags":["Air Quality Forecast"]}},"/forecast/daily?city={city}&country={country}":{"get":{"description":"Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC. Accepts a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.\n","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Number of days to return. Default 16.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a daily forecast - Given City and/or State, Country.","tags":["16 day / daily Forecast"]}},"/forecast/daily?city_id={city_id}":{"get":{"description":"Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC.\n","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Number of days to return. Default 16.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a daily forecast - Given a City ID.","tags":["16 day / daily Forecast"]}},"/forecast/daily?lat={lat}&lon={lon}":{"get":{"description":"Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC. \n","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Number of days to return. Default 16.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a daily forecast - Given Lat/Lon.","tags":["16 day / daily Forecast"]}},"/forecast/daily?postal_code={postal_code}":{"get":{"description":"Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC.\n","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of days to return. Default 16.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a daily forecast - Given a Postal Code.","tags":["16 day / daily Forecast"]}},"/forecast/energy?lat={lat}&lon={lon}":{"get":{"description":"Retrieve an 8 day forecast relevant to te Energy Sector (degree days, solar radiation, precipitation, wind).","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Temperature threshold to use to calculate degree days (default 18 C) ","in":"query","name":"threshold","required":false,"schema":{"type":"number","format":"double"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Time period (default: daily)","in":"query","name":"tp","required":false,"schema":{"type":"string","format":"string","enum":["hourly","daily"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Energy Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnergyObsGroupForecast"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns Energy Forecast API response  - Given a single lat/lon. ","tags":["Forecast Degree Day API"]}},"/forecast/hourly?city={city}&country={country}":{"get":{"description":" Returns an hourly forecast, where each point represents a one hour   period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. Accepts a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.\n","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of hours to return.","in":"query","name":"hours","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns an hourly forecast - Given City and/or State, Country.","tags":["240 hour / hourly Forecast"]}},"/forecast/hourly?city_id={city_id}":{"get":{"description":" Returns an hourly forecast, where each point represents a one hour   period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. \n","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of hours to return.","in":"query","name":"hours","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns an hourly forecast - Given a City ID.","tags":["240 hour / hourly Forecast"]}},"/forecast/hourly?lat={lat}&lon={lon}":{"get":{"description":"Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. \n","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}},{"description":"Number of hours to return.","in":"query","name":"hours","required":false,"schema":{"type":"integer","format":"integer"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns an hourly forecast - Given a lat/lon.","tags":["240 hour / hourly Forecast"]}},"/forecast/hourly?postal_code={postal_code}":{"get":{"description":" Returns an hourly forecast, where each point represents a one hour   period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. \n","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of hours to return.","in":"query","name":"hours","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns an hourly forecast - Given a Postal Code.","tags":["240 hour / hourly Forecast"]}},"/history/airquality?city={city}&country={country}":{"get":{"description":"Returns historical air quality conditions.","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Historical air quality conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQCurrentGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns 72 hours of historical quality conditions - Given City and/or State, Country.","tags":["Historical Air Quality"]}},"/history/airquality?city_id={city_id}":{"get":{"description":"Returns historical air quality conditions.","parameters":[{"description":"City ID.","in":"path","name":"city_id","required":true,"schema":{"type":"number","format":"double"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Historical air quality conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQCurrentGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns 72 hours of historical air quality conditions - Given a City ID.","tags":["Historical Air Quality"]}},"/history/airquality?lat={lat}&lon={lon}":{"get":{"description":"Returns historical air quality conditions.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Historical air quality conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQCurrentGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns 72 hours of historical air quality conditions - Given a lat/lon.","tags":["Historical Air Quality"]}},"/history/airquality?postal_code={postal_code}":{"get":{"description":"Returns historical air quality conditions.","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Historical air quality conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AQCurrentGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns 72 hours of historical air quality conditions - Given a Postal Code.","tags":["Historical Air Quality"]}},"/history/daily?city={city}&country={country}":{"get":{"description":"Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate. **(LIMIT 1 year per request)**","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"de