Security News
OpenJS: “XZ Utils Cyberattack Likely Not an Isolated Incident”
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
By Sarah Gooding - Apr 17, 2024
@datafire/weatherbit
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 1
Weekly downloads
Readme
@datafire/weatherbit
Client library for Weatherbit.io - Swagger UI Weather API documentation
Installation and Usage
npm install --save @datafire/weatherbit
let weatherbit = require('@datafire/weatherbit').create();
.then(data => {
console.log(data);
});
Description
This is the documentation for the Weatherbit Weather API. The base URL for the API is http://api.weatherbit.io/v2.0/ or https://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 5 day forecast for London, UK would be http://api.weatherbit.io/v2.0/forecast/3hourly?city=London&country=UK. See our Weather API description page for additional documentation.
Actions
alerts_lat_lat_lon_lon.get
Returns severe weather alerts issued by meteorological agencies - given a lat, and a lon.
weatherbit.alerts_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - callback
string: Wraps return in jsonp callback - Example - callback=func - key required
string: Your registered API key.
- lat required
Output
- output WeatherAlert
bulk.files.file.get
(Advanceed/Enterprise plans only) Downloads bulk data files - OPTIONS: ( current.json.gz - Current observations for cities > 1000 population). Units are Metric (Celcius, m/s, etc).
weatherbit.bulk.files.file.get({
"file": "",
"key": ""
}, context)
Input
- input
object- file required
string: Filename (ie. current.json.gz) - key required
string: Your registered API key.
- file required
Output
- output Error
bulk.history.daily_city_city_country_country.get
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.
weatherbit.bulk.history.daily_city_city_country_country.get({
"city": "",
"country": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city required
Output
- output HistoryDay
bulk.history.daily_city_id_city_id.get
Returns Historical Observations - Given a City ID.
weatherbit.bulk.history.daily_city_id_city_id.get({
"city_id": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- city_id required
string: City ID. Example: 4487042 - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH) - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city_id required
Output
- output HistoryDay
bulk.history.daily_lat_lat_lon_lon.get
Returns Historical Observations - Given a lat, and lon.
weatherbit.bulk.history.daily_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- lat required
Output
- output HistoryDay
bulk.history.daily_postal_code_postal_code.get
Returns Historical Observations - Given a Postal Code.
weatherbit.bulk.history.daily_postal_code_postal_code.get({
"postal_code": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- postal_code required
string: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH) - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output HistoryDay
bulk.history.daily_station_station.get
Returns Historical Observations - Given a station ID.
weatherbit.bulk.history.daily_station_station.get({
"station": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- station required
string: Station ID. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- station required
Output
- output HistoryDay
bulk.history.hourly_city_city_country_country.get
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.
weatherbit.bulk.history.hourly_city_city_country_country.get({
"city": "",
"country": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city required
Output
- output History
bulk.history.hourly_city_id_city_id.get
Returns Historical Observations - Given a City ID.
weatherbit.bulk.history.hourly_city_id_city_id.get({
"city_id": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- city_id required
string: City ID. Example: 4487042 - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH) - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city_id required
Output
- output History
bulk.history.hourly_lat_lat_lon_lon.get
Returns Historical Observations - Given a lat, and lon.
weatherbit.bulk.history.hourly_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- lat required
Output
- output History
bulk.history.hourly_postal_code_postal_code.get
Returns Historical Observations - Given a Postal Code.
weatherbit.bulk.history.hourly_postal_code_postal_code.get({
"postal_code": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- postal_code required
string: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH) - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output History
bulk.history.hourly_station_station.get
Returns Historical Observations - Given a station ID.
weatherbit.bulk.history.hourly_station_station.get({
"station": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- station required
string: Station ID. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- station required
Output
- output History
current.airquality_city_city_country_country.get
Returns current air quality conditions.
weatherbit.current.airquality_city_city_country_country.get({
"city": "",
"country": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city required
Output
- output AQCurrentGroup
current.airquality_city_id_city_id.get
Returns current air quality conditions.
weatherbit.current.airquality_city_id_city_id.get({
"city_id": 0,
"key": ""
}, context)
Input
- input
object- city_id required
integer: City ID. Example: 4487042 - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- city_id required
Output
- output AQCurrentGroup
current.airquality_lat_lat_lon_lon.get
Returns current air quality conditions.
weatherbit.current.airquality_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- lat required
Output
- output AQCurrentGroup
current.airquality_postal_code_postal_code.get
Returns current air quality conditions.
weatherbit.current.airquality_postal_code_postal_code.get({
"postal_code": 0,
"key": ""
}, context)
Input
- input
object- postal_code required
integer: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output AQCurrentGroup
current_cities_cities.get
Returns a group of Current Observations - Given a list of City IDs.
weatherbit.current_cities_cities.get({
"cities": "",
"key": ""
}, context)
Input
- input
object- cities required
string: Comma separated list of City ID's. Example: 4487042, 4494942, 4504871 - units
string(values: S, I): Convert to units. Default Metric See units field description - marine
string(values: t): Marine stations only (buoys, oil platforms, etc) - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback - Example - callback=func - key required
string: Your registered API key.
- cities required
Output
- output CurrentObsGroup
current_city_city_country_country.get
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.
weatherbit.current_city_city_country_country.get({
"city": "",
"country": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - marine
string(values: t): Marine stations only (buoys, oil platforms, etc) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback - Example - callback=func - key required
string: Your registered API key.
- city required
Output
- output CurrentObsGroup
current_city_id_city_id.get
Returns current weather observation - Given a City ID.
weatherbit.current_city_id_city_id.get({
"city_id": "",
"key": ""
}, context)
Input
- input
object- city_id required
string: City ID. Example: 4487042 - units
string(values: S, I): Convert to units. Default Metric See units field description - marine
string(values: t): Marine stations only (buoys, oil platforms, etc) - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback - Example - callback=func - key required
string: Your registered API key.
- city_id required
Output
- output CurrentObsGroup
current_lat_lat_lon_lon.get
Returns a Current Observation - given a lat, and a lon.
weatherbit.current_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - marine
string(values: t): Marine stations only (buoys, oil platforms, etc) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback - Example - callback=func - key required
string: Your registered API key.
- lat required
Output
- output CurrentObsGroup
current_postal_code_postal_code.get
Returns current weather observation - Given a Postal Code.
weatherbit.current_postal_code_postal_code.get({
"postal_code": "",
"key": ""
}, context)
Input
- input
object- postal_code required
string: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - marine
string(values: t): Marine stations only (buoys, oil platforms, etc) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback - Example - callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output CurrentObsGroup
current_station_station.get
Returns a Current Observation - Given a station ID.
weatherbit.current_station_station.get({
"station": "",
"key": ""
}, context)
Input
- input
object- station required
string: Station Call ID. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- station required
Output
- output CurrentObsGroup
current_stations_stations.get
Returns a group of Current Observations - Given a list of Station Call IDs.
weatherbit.current_stations_stations.get({
"stations": "",
"key": ""
}, context)
Input
- input
object- stations required
string: Comma separated list of Station Call ID's. Example: KRDU,KBFI,KVNY - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- stations required
Output
- output CurrentObsGroup
forecast.3hourly_city_city_country_country.get
Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format "YYYY-MM-DD:HH". Time is UTC.
weatherbit.forecast.3hourly_city_city_country_country.get({
"city": "",
"country": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - days
number: Number of days to return. Default 5. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- city required
Output
- output ForecastHourly
forecast.3hourly_city_id_city_id.get
Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format "YYYY-MM-DD:HH". Time is UTC.
weatherbit.forecast.3hourly_city_id_city_id.get({
"city_id": 0,
"key": ""
}, context)
Input
- input
object- city_id required
integer: City ID. Example: 4487042 - days
number: Number of days to return. Default 5. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city_id required
Output
- output ForecastHourly
forecast.3hourly_lat_lat_lon_lon.get
Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format "YYYY-MM-DD:HH". Time is UTC.
weatherbit.forecast.3hourly_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - days
number: Number of days to return. Default 5. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- lat required
Output
- output ForecastHourly
forecast.3hourly_postal_code_postal_code.get
Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format "YYYY-MM-DD:HH". Time is UTC.
weatherbit.forecast.3hourly_postal_code_postal_code.get({
"postal_code": 0,
"key": ""
}, context)
Input
- input
object- postal_code required
integer: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - days
number: Number of days to return. Default 5. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output ForecastHourly
forecast.airquality_city_city_country_country.get
Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.
weatherbit.forecast.airquality_city_city_country_country.get({
"city": "",
"country": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - callback
string: Wraps return in jsonp callback. Example: callback=func - hours
integer: Number of hours to return. - key required
string: Your registered API key.
- city required
Output
- output AQHourly
forecast.airquality_city_id_city_id.get
Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.
weatherbit.forecast.airquality_city_id_city_id.get({
"city_id": 0,
"key": ""
}, context)
Input
- input
object- city_id required
integer: City ID. Example: 4487042 - callback
string: Wraps return in jsonp callback. Example - callback=func - hours
integer: Number of hours to return. - key required
string: Your registered API key.
- city_id required
Output
- output AQHourly
forecast.airquality_lat_lat_lon_lon.get
Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.
weatherbit.forecast.airquality_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key. - hours
integer: Number of hours to return.
- lat required
Output
- output AQHourly
forecast.airquality_postal_code_postal_code.get
Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.
weatherbit.forecast.airquality_postal_code_postal_code.get({
"postal_code": 0,
"key": ""
}, context)
Input
- input
object- postal_code required
integer: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - callback
string: Wraps return in jsonp callback. Example - callback=func - hours
integer: Number of hours to return. - key required
string: Your registered API key.
- postal_code required
Output
- output AQHourly
forecast.daily_city_city_country_country.get
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.
weatherbit.forecast.daily_city_city_country_country.get({
"city": "",
"country": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - days
number: Number of days to return. Default 16. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- city required
Output
- output ForecastDay
forecast.daily_city_id_city_id.get
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.
weatherbit.forecast.daily_city_id_city_id.get({
"city_id": 0,
"key": ""
}, context)
Input
- input
object- city_id required
integer: City ID. Example: 4487042 - days
number: Number of days to return. Default 16. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city_id required
Output
- output ForecastDay
forecast.daily_lat_lat_lon_lon.get
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.
weatherbit.forecast.daily_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - days
number: Number of days to return. Default 16. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- lat required
Output
- output ForecastDay
forecast.daily_postal_code_postal_code.get
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.
weatherbit.forecast.daily_postal_code_postal_code.get({
"postal_code": 0,
"key": ""
}, context)
Input
- input
object- postal_code required
integer: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - days
number: Number of days to return. Default 16. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output ForecastDay
forecast.energy_lat_lat_lon_lon.get
Retrieve an 8 day forecast relevant to te Energy Sector (degree days, solar radiation, precipitation, wind).
weatherbit.forecast.energy_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - threshold
number: Temperature threshold to use to calculate degree days (default 18 C) - units
string(values: S, I): Convert to units. Default Metric See units field description - tp
string(values: hourly, daily): Time period (default: daily) - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- lat required
Output
- output EnergyObsGroupForecast
forecast.hourly_city_city_country_country.get
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.
weatherbit.forecast.hourly_city_city_country_country.get({
"city": "",
"country": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - hours
integer: Number of hours to return. - key required
string: Your registered API key.
- city required
Output
- output ForecastHourly
forecast.hourly_city_id_city_id.get
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.
weatherbit.forecast.hourly_city_id_city_id.get({
"city_id": 0,
"key": ""
}, context)
Input
- input
object- city_id required
integer: City ID. Example: 4487042 - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example - callback=func - hours
integer: Number of hours to return. - key required
string: Your registered API key.
- city_id required
Output
- output ForecastHourly
forecast.hourly_lat_lat_lon_lon.get
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.
weatherbit.forecast.hourly_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key. - hours
integer: Number of hours to return.
- lat required
Output
- output ForecastHourly
forecast.hourly_postal_code_postal_code.get
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.
weatherbit.forecast.hourly_postal_code_postal_code.get({
"postal_code": 0,
"key": ""
}, context)
Input
- input
object- postal_code required
integer: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example - callback=func - hours
integer: Number of hours to return. - key required
string: Your registered API key.
- postal_code required
Output
- output ForecastHourly
history.airquality_city_city_country_country.get
Returns historical air quality conditions.
weatherbit.history.airquality_city_city_country_country.get({
"city": "",
"country": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city required
Output
- output AQCurrentGroup
history.airquality_city_id_city_id.get
Returns historical air quality conditions.
weatherbit.history.airquality_city_id_city_id.get({
"city_id": 0,
"key": ""
}, context)
Input
- input
object- city_id required
number: City ID. - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- city_id required
Output
- output AQCurrentGroup
history.airquality_lat_lat_lon_lon.get
Returns historical air quality conditions.
weatherbit.history.airquality_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- lat required
Output
- output AQCurrentGroup
history.airquality_postal_code_postal_code.get
Returns historical air quality conditions.
weatherbit.history.airquality_postal_code_postal_code.get({
"postal_code": 0,
"key": ""
}, context)
Input
- input
object- postal_code required
integer: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - callback
string: Wraps return in jsonp callback. Example - callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output AQCurrentGroup
history.daily_city_city_country_country.get
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 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.daily_city_city_country_country.get({
"city": "",
"country": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city required
Output
- output HistoryDay
history.daily_city_id_city_id.get
Returns Historical Observations - Given a City ID. (LIMIT 1 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.daily_city_id_city_id.get({
"city_id": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- city_id required
string: City ID. Example: 4487042 - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH) - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city_id required
Output
- output HistoryDay
history.daily_lat_lat_lon_lon.get
Returns Historical Observations - Given a lat, and lon. (LIMIT 1 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.daily_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- lat required
Output
- output HistoryDay
history.daily_postal_code_postal_code.get
Returns Historical Observations - Given a Postal Code. (LIMIT 1 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.daily_postal_code_postal_code.get({
"postal_code": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- postal_code required
string: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH) - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output HistoryDay
history.daily_station_station.get
Returns Historical Observations - Given a station ID. (LIMIT 1 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.daily_station_station.get({
"station": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- station required
string: Station ID. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- station required
Output
- output HistoryDay
history.energy.bbox_lat1_lat1_lon1_lon1_lat2_lat2_lon2_lon2.get
Returns aggregate energy specific historical weather fields, over a specified time period. Supply a bounding box ex: lat1=40&lon1=-78&lat2=38&lon2=-80. This API will return UP TO 150 stations, aggregated by the specified time period start_date to end_date.
weatherbit.history.energy.bbox_lat1_lat1_lon1_lon1_lat2_lat2_lon2_lon2.get({
"lat1": 0,
"lon1": 0,
"lat2": 0,
"lon2": 0,
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- lat1 required
number: Latitude of upper left corner. - lon1 required
number: Longitude of upper left corner. - lat2 required
number: Latitude of lower right corner. - lon2 required
number: Longitude of lower right corner. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - threshold
number: Temperature threshold to use to calculate degree days (default 18 C) - units
string(values: S, I): Convert to units. Default Metric See units field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- lat1 required
Output
- output EnergyObsGroup
history.energy_lat_lat_lon_lon.get
Returns aggregate energy specific historical weather fields, over a specified time period.
weatherbit.history.energy_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - tp
string(values: hourly, daily, monthly): Time period to aggregate by (daily, monthly) - threshold
number: Temperature threshold to use to calculate degree days (default 18 C) - units
string(values: S, I): Convert to units. Default Metric See units field description - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- lat required
Output
- output EnergyObsGroup
history.hourly_city_city_country_country.get
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 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.hourly_city_city_country_country.get({
"city": "",
"country": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- city required
string: City search. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR - state
string: Full name of state. - country required
string: Country Code (2 letter). - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - tz
string(values: local, utc): Assume utc (default) or local time for start_date, end_date - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city required
Output
- output History
history.hourly_city_id_city_id.get
Returns Historical Observations - Given a City ID. (LIMIT 1 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.hourly_city_id_city_id.get({
"city_id": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- city_id required
string: City ID. Example: 4487042 - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH) - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - tz
string(values: local, utc): Assume utc (default) or local time for start_date, end_date - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- city_id required
Output
- output History
history.hourly_lat_lat_lon_lon.get
Returns Historical Observations - Given a lat, and lon. (LIMIT 1 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.hourly_lat_lat_lon_lon.get({
"lat": 0,
"lon": 0,
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- lat required
number: Latitude component of location. - lon required
number: Longitude component of location. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - tz
string(values: local, utc): Assume utc (default) or local time for start_date, end_date - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- lat required
Output
- output History
history.hourly_postal_code_postal_code.get
Returns Historical Observations - Given a Postal Code. (LIMIT 1 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.hourly_postal_code_postal_code.get({
"postal_code": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- postal_code required
string: Postal Code. Example: 28546 - country
string: Country Code (2 letter). - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH) - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH) - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - tz
string(values: local, utc): Assume utc (default) or local time for start_date, end_date - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- postal_code required
Output
- output History
history.hourly_station_station.get
Returns Historical Observations - Given a station ID. (LIMIT 1 day for Free plan. LIMIT 7 days for Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)
weatherbit.history.hourly_station_station.get({
"station": "",
"start_date": "",
"end_date": "",
"key": ""
}, context)
Input
- input
object- station required
string: Station ID. - start_date required
string: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH). - end_date required
string: End Date (YYYY-MM-DD or YYYY-MM-DD:HH). - units
string(values: S, I): Convert to units. Default Metric See units field description - lang
string(values: 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): Language (Default: English) See language field description - tz
string(values: local, utc): Assume utc (default) or local time for start_date, end_date - callback
string: Wraps return in jsonp callback. Example: callback=func - key required
string: Your registered API key.
- station required
Output
- output History
Definitions
AQCurrent
- AQCurrent
object- aqi
integer: Cloud cover as a percentage (%) - no2
number: Concentration of NO2 (µg/m³) - o3
number: Concentration of O3 (µg/m³) - pm10
number: Concentration of PM 10 (µg/m³) - pm25
number: Concentration of PM 2.5 (µg/m³) - so2
number: Concentration of SO2 (µg/m³)
- aqi
AQCurrentGroup
- AQCurrentGroup
object- city_name
string: City Name - country_code
string: Country Abbreviation - data
array- items AQCurrent
- lat
string: Latitude - lon
string: Longitude - state_code
string: State Abbreviation - timezone
string: Local IANA time zone
- city_name
AQHour
- AQHour
object- aqi
integer: Cloud cover as a percentage (%) - no2
number: Concentration of NO2 (µg/m³) - o3
number: Concentration of O3 (µg/m³) - pm10
number: Concentration of PM 10 (µg/m³) - pm25
number: Concentration of PM 2.5 (µg/m³) - so2
number: Concentration of SO2 (µg/m³) - timestamp_local
string: Timestamp in local time - timestamp_utc
string: Timestamp UTC - ts
number: Unix Timestamp
- aqi
AQHourly
- AQHourly
object- city_name
string: City Name - country_code
string: Country Abbreviation - data
array- items AQHour
- lat
string: Latitude - lon
string: Longitude - state_code
string: State Abbreviation - timezone
string: Local IANA time zone
- city_name
AlertRegionGroup
- AlertRegionGroup
string: List of impacted regions
CurrentObs
- CurrentObs
object- app_temp
number: Apparent temperature - Default (C) - aqi
number: Air quality index (US EPA standard 0 to +500) - city_name
string: City name (closest) - clouds
integer: Cloud cover (%) - country_code
string: Country abbreviation - datetime
string: Cycle Hour (UTC) of observation - dewpt
number: Dew point temperature - default (C) - dhi
number: Diffuse horizontal irradiance (W/m^2) - dni
number: Direct normal irradiance (W/m^2) - elev_angle
number: Current solar elevation angle (Degrees) - ghi
number: Global horizontal irradiance (W/m^2) - hour_angle
number: Current solar hour angle (Degrees) - lat
number: Latitude - lon
number: Longitude - ob_time
string: Full time (UTC) of observation (YYYY-MM-DD HH:MM) - pod
string: Part of the day (d = day, n = night) - precip
number: Precipitation in last hour - Default (mm) - pres
number: Pressure (mb) - rh
integer: Relative humidity (%) - slp
number: Mean sea level pressure in millibars (mb) - snow
number: Snowfall in last hour - Default (mm) - solar_rad
number: Estimated solar radiation (W/m^2) - state_code
string: State abbreviation - station
string: Source Station ID - sunrise
string: Time (UTC) of Sunrise (HH:MM) - sunset
string: Time (UTC) of Sunset (HH:MM) - temp
number: Temperature - Default (C) - timezone
string: Local IANA time zone - ts
number: Unix Timestamp - uv
number: UV Index - vis
integer: Visibility - default (M) - weather
object- code
string: Weather Condition code - description
string: Weather Condition description - icon
string: Icon code for forecast image display
- code
- wind_cdir
string: Cardinal wind direction - wind_cdir_full
string: Cardinal wind direction (text) - wind_dir
integer: Wind direction (degrees) - wind_speed
number: Wind speed - Default (m/s)
- app_temp
CurrentObsGroup
- CurrentObsGroup
object- count
integer: Count of found observations - data
array- items CurrentObs
- count
EnergyObs
- EnergyObs
object- cdd
number: Cooling degree days - city_name
string: City name (closest) - clouds
integer: Average cloud cover (%) - country_code
string: Country abbreviation - dewpt
number: Average dew point temperature - Default (C) - hdd
number: Heating degree days - lat
string: Latitude - lon
string: Longitude - precip
number: Total precipitation in period - Default (mm) - rh
integer: Average Relative humidity (%) - snow
number: Total snowfall in period - Default (mm) - state_code
string: State abbreviation - station_id
string: Source Station ID - sun_hours
number: Average number of daily sun hours - # hours where Solar GHI > 1000 W/m^2 - t_dhi
number: Total diffuse horizontal solar irradiance (W/m^2) - t_dni
number: Total direct normal solar irradiance (W/m^2) - t_ghi
number: Total global horizontal solar irradiance (W/m^2) - temp
number: Average temperature - Default (C) - timezone
string: Local IANA time zone - wind_dir
integer: Average wind direction (Degrees) - wind_speed
number: Average wind speed - Default (m/s)
- cdd
EnergyObsGroup
- EnergyObsGroup
object- count
integer: Count of found observations - data
array- items EnergyObs
- end_date
integer: End Date - start_date
integer: Start Date
- count
EnergyObsGroupForecast
- EnergyObsGroupForecast
object- city_name
string: City name (closest) - country_code
string: Country abbreviation - data
array- items EnergyObsSeries
- lat
string: Latitude - lon
string: Longitude - state_code
string: State abbreviation - threshold_units
string: Degree day threshold units - threshold_value
string: Degree day threshold - timezone
string: Local IANA time zone
- city_name
EnergyObsSeries
- EnergyObsSeries
object- cdd
number: Cooling degree days - clouds
integer: Average cloud cover (%) - date
string: Date - dewpt
number: Average dew point temperature - Default (C) - hdd
number: Heating degree days - precip
number: Total precipitation in period - Default (mm) - rh
integer: Average Relative humidity (%) - snow
number: Total snowfall in period - Default (mm) - sun_hours
number: Average number of daily sun hours - # hours where Solar GHI > 1000 W/m^2 - t_dhi
number: Total diffuse horizontal solar irradiance (W/m^2) - t_dni
number: Total direct normal solar irradiance (W/m^2) - t_ghi
number: Total global horizontal solar irradiance (W/m^2) - temp
number: Average temperature - Default (C) - wind_dir
integer: Average wind direction (Degrees) - wind_speed
number: Average wind speed - Default (m/s)
- cdd
Error
- Error
object- code
integer - message
string
- code
Forecast
- Forecast
object- app_max_temp
number: Apparent Maximum daily Temperature - default (C) - app_min_temp
number: Apparent Minimum daily Temperature - default (C) - clouds
integer: Cloud cover as a percentage (%) - datetime
string: Date in format "YYYY-MM-DD:HH". All datetime is in (UTC) - dewpt
number: Dewpoint (Average) - default (C) - max_dhi
number: [Deprecated] Max direct component of solar insolation (W/m^2) - max_temp
number: Maximum daily Temperature - default (C) - min_temp
number: Minimum daily Temperature - default (C) - moon_phase
number: Moon phase - moonrise_ts
integer: Moonrise unix timestamp - moonset_ts
integer: Moonset unix timestamp - pod
string: Part of the day (d = day, n = night) - pop
number: Chance of Precipitation as a percentage (%) - precip
number: Accumulated precipitation since last forecast point - default (mm) - pres
number: Pressure (mb) - rh
integer: Relative Humidity as a percentage (%) - slp
number: Mean Sea level pressure (mb) - snow
number: Accumulated snowfall since last forecast point - default (mm) - snow_depth
number: Snow Depth - default (mm) - sunrise_ts
integer: Sunrise unix timestamp - sunset_ts
integer: Sunset unix timestamp - temp
number: Temperature (Average) - default (C) - timestamp_local
string: Timestamp in local time - timestamp_utc
string: Timestamp UTC - ts
number: Unix Timestamp - uv
number: UV Index - vis
number: Average Visibility default (KM) - weather
object- code
string: Weather Condition code - description
string: Weather Condition description - icon
string: Icon code for forecast image display
- code
- wind_cdir
string: Cardinal wind direction - wind_cdir_full
string: Cardinal wind direction (text) - wind_dir
integer: Wind direction - wind_spd
number: Wind Speed (default m/s)
- app_max_temp
ForecastDay
- ForecastDay
object- city_name
string: City Name - country_code
string: Country Abbreviation - data
array- items Forecast
- lat
string: Latitude - lon
string: Longitude - state_code
string: State Abbreviation - timezone
string: Local IANA time zone
- city_name
ForecastHour
- ForecastHour
object- app_temp
number: Apparent Temperature - Default (C) - clouds
integer: Cloud cover as a percentage (%) - datetime
string: Date in format "YYYY-MM-DD:HH". All datetime is in (UTC) - dewpt
number: Dewpoint - Default (C) - dhi
number: Diffuse normal solar irradiance (W/m^2) - dni
number: Direct normal solar irradiance (W/m^2) - ghi
number: Global horizontal solar irradiance (W/m^2) - pod
string: Part of day (d = day, n = night) - pop
number: Chance of Precipitation as a percentage (%) - precip
number: Accumulated precipitation since last forecast point. Default (mm) - pres
number: Pressure (mb) - rh
integer: Relative Humidity as a percentage (%) - slp
number: Mean Sea level pressure (mb) - snow
number: Accumulated snowfall since last forecast point - Default (mm) - snow6h
number: 6 hour accumulated snowfall. Default (mm) - snow_depth
number: Snow depth - Default (mm) - solar_rad
number: Estimated solar radiation (W/m^2) - temp
number: Temperature - Default (C) - timestamp_local
string: Timestamp in local time - timestamp_utc
string: Timestamp UTC - ts
number: Unix Timestamp - uv
number: UV Index - vis
number: Visibility - Default (KM) - weather
object- code
string: Weather Condition code - description
string: Weather Condition description - icon
string: Icon code for forecast image display
- code
- wind_cdir
string: Cardinal wind direction - wind_cdir_full
string: Cardinal wind direction (text) - wind_dir
integer: Wind direction - wind_spd
number: Wind Speed - Default (m/s)
- app_temp
ForecastHourly
- ForecastHourly
object- city_name
string: City Name - country_code
string: Country Abbreviation - data
array- items ForecastHour
- lat
string: Latitude - lon
string: Longitude - state_code
string: State Abbreviation - timezone
string: Local IANA time zone
- city_name
GeoIPObj
- GeoIPObj
object- area_code
string: Area Code - charset
string: Character encoding - city
string: City Name - continent_code
string: Country Abbreviation - country_code
string: Country Code (Short) - country_code3
string: Country Code (Long) - dma_code
string: Longitude - ip
string: IP Address - latitude
string: State Abbreviation - longitude
string: City Name - metro_code
string: Longitude - offset
string: UTC Offset (deprecated) - organization
string: Organization Name - postal_code
string: Postal Code - region
string: Latitude - timezone
string: Local IANA time zone
- area_code
History
- History
object- city_name
string: City name (Closest) - country_code
string: Country abbreviation - data
array- items HistoryObj
- lat
string: Latitude - lon
string: Longitude - sources
array: Weather stations used in response- items
string
- items
- state_code
string: State abbreviation - timezone
string: Local IANA time zone
- city_name
HistoryDay
- HistoryDay
object- city_name
string: City name (Closest) - country_code
string: Country abbreviation - data
array- items HistoryDayObj
- lat
string: Latitude - lon
string: Longitude - sources
array: Weather stations used in response- items
string
- items
- state_code
string: State abbreviation - timezone
string: Local IANA time zone
- city_name
HistoryDayObj
- HistoryDayObj
object- datetime
string: Date in format "YYYY-MM-DD". All datetime is in (UTC) - dewpt
number: Average dewpoint - Default (C) - dhi
integer: Average hourly diffuse horizontal solar irradiance (W/m^2) - dni
integer: Average direct normal solar irradiance (W/m^2) - ghi
integer: Average hourly global horizontal solar irradiance (W/m^2) - max_temp
number: Max temperature - Default (C) - max_temp_ts
number: Time of max memperature - Unix Timestamp - max_uv
integer: Max UV Index (1-11+) - max_wind_dir
integer: Direction of wind at time of max 2min wind (degrees) - max_wind_spd
number: Max 2min Wind Speed - default (m/s) - max_wind_spd_ts
number: Time of max 2min wind - unix timestamp - min_temp
number: Min temperature - Default (C) - min_temp_ts
number: Time of max temperature - unix timestamp - precip
number: Liquid equivalent precipitation - default (mm) - precip_gpm
number: Satellite estimated liquid equivalent precipitation - default (mm) - pres
number: Average pressure (mb) - rh
integer: Average relative humidity as a percentage (%) - slp
number: Average sea level pressure (mb) - snow
number: Snowfall - default (mm) - snow_depth
number: Snow Depth - default (mm) - t_dhi
integer: Total diffuse horizontal solar irradiance (W/m^2) - t_dni
integer: Total direct normal solar irradiance (W/m^2) - t_ghi
integer: Total global horizontal solar irradiance (W/m^2) - temp
number: Average temperature - Default (C) - ts
integer: Unix timestamp of datetime (Midnight UTC) - wind_dir
integer: Average wind direction (degrees) - wind_gust_spd
number: Wind gust speed - default (m/s) - wind_spd
number: Average wind speed - default (m/s)
- datetime
HistoryObj
- HistoryObj
object- datetime
string: Date in format "YYYY-MM-DD:HH". All datetime is in (UTC) - dewpt
integer: Dew point (Default Celcius) - dhi
number: Diffuse normal solar irradiance (W/m^2) - dni
number: Direct normal solar irradiance (W/m^2) - elev_angle
number: Solar elevation angle (Degrees) - ghi
number: Global horizontal solar irradiance (W/m^2) - h_angle
number: Solar hour angle (Degrees) - pod
string: Part of the day (d = day, n = night) - precip
number: Liquid equivalent precipitation - Default (mm) - pres
number: Pressure (mb) - rh
integer: Relative Humidity as a percentage (%) - slp
number: Sea level pressure (mb) - snow
number: Snowfall - Default (mm) - snow6h
number: Snowfall in last 6 hours - Default (mm) - solar_rad
number: Estimated solar radiation (W/m^2) - temp
number: Temperature (Default Celcius) - timestamp_local
string: Timestamp in local time - timestamp_utc
string: Timestamp UTC - ts
number: Unix Timestamp - uv
integer: UV Index (1-11+) - weather
object- code
string: Weather Condition code - description
string: Weather Condition description - icon
string: Icon code for forecast image display
- code
- wind_dir
integer: Wind direction (Degrees) - wind_spd
number: Wind Speed (Default m/s)
- datetime
WeatherAlert
- WeatherAlert
object- alerts
array- items WeatherAlertGroup
- lat
number: Latitude - lon
number: Longitude
- alerts
WeatherAlertGroup
- WeatherAlertGroup
object- alerts
array- items AlertRegionGroup
- description
string: Full description of weather alert - effective_local
string: Issued time local - effective_utc
string: Issued time UTC - expires_local
string: Expiration time local - expires_utc
string: Expiration time UTC - severity
string: Severity of weather. (Advisory | Watch | Warning) - title
string: Brief description of weather alert - uri
string: URI to weather alert
- alerts
FAQs
DataFire integration for Weatherbit.io - Swagger UI Weather API documentation
The npm package @datafire/weatherbit receives a total of 1 weekly downloads. As such, @datafire/weatherbit popularity was classified as not popular.
We found that @datafire/weatherbit demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Last updated on 21 Dec 2020
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Company News
Connect with Socket at RSA and BSidesSF 2024
Come meet the Socket team at BSidesSF and RSA! We're sponsoring several fun networking events and we would love to see you there.
By Sarah Gooding - Apr 15, 2024
Security News
OSI to Lead Discussions on Navigating the Challenges of Doing Business with Open Source
OSI is starting a conversation aimed at removing the excuse of the SaaS loophole for companies navigating licensing and the complexities of doing business with open source.
By Sarah Gooding - Apr 12, 2024