openapi: 3.0.1
info:
title: Weatherbit - Interactive Swagger UI Documentation
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."
version: 2.0.0
servers:
- url: https://api.weatherbit.io/v2.0
- url: http://api.weatherbit.io/v2.0
paths:
/alerts:
get:
tags:
- Alerts
summary: Weatherbit Returns Severe Weather Alerts Issued by Meteorological Agencies - Given a Lat/lon.
description: "Returns severe weather alerts issued by meteorological agencies - given a lat, and a lon."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 3.93
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 9.38
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: station
in: query
description: Station Call ID.
schema:
type: string
format: string
example: example-value
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
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'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/current:
get:
tags:
- Current Weather Data
summary: Weatherbit Returns a Current Observation - Given a Lat/lon.
description: "Returns a Current Observation - given a lat, and a lon."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 58.5
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 74.68
- name: include
in: query
description: "Include 1 hour - minutely precip forecast in the response, or severe weather alerts"
schema:
type: string
format: string
enum:
- minutely
- alerts
example: minutely
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: station
in: query
description: Station Call ID.
schema:
type: string
format: string
example: example-value
- name: stations
in: query
description: "Comma separated list of Station Call ID's. Example: KRDU,KBFI,KVNY"
schema:
type: string
format: string
example: example-value
- name: points
in: query
description: "Comma separated list of points. Example: (35.5, -75.5),(45, 65),(45.12, -130.5)"
schema:
type: string
format: string
example: example-value
- name: cities
in: query
description: "Comma separated list of City ID's. Example: 4487042, 4494942, 4504871"
schema:
type: string
format: string
example: example-value
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: S
- name: lang
in: query
description: "Language (Default: English) See language field description"
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
example: uk
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
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'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/forecast/daily:
get:
tags:
- 16 Day / Daily Forecast
summary: Weatherbit Returns a Daily Forecast - Given Lat/Lon.
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:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 44.48
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 23.85
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: station
in: query
description: Station Call ID.
schema:
type: string
format: string
example: example-value
- name: days
in: query
description: Number of days to return. Default 16.
schema:
type: number
format: integer
example: 29.76
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: S
- name: lang
in: query
description: "Language (Default: English) See language field description"
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
example: el
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
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'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/forecast/minutely:
get:
tags:
- 60 Minute Rain/Snow Nowcast
summary: Weatherbit Returns a 60 Minute Precipitation Forecast - Given Lat/Lon.
description: "Returns a 60 minute precipitation forecast, where each point represents one minute (1 min) period."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 22.12
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 91.76
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: station
in: query
description: Station Call ID.
schema:
type: string
format: string
example: example-value
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: S
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
"200":
description: A forecast object.
content:
application/json:
schema:
$ref: '#/components/schemas/FCMinutely'
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/forecast/airquality:
get:
tags:
- Air Quality Forecast
summary: Weatherbit Returns 72 Hour (hourly) Air Quality Forecast - Given a Geolocation.
description: "Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 40.04
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 59.0
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
- name: hours
in: query
description: Number of hours to return.
schema:
type: integer
format: integer
example: 17
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'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/history/airquality:
get:
tags:
- Historical Air Quality
summary: Weatherbit Returns 72 Hours of Historical Air Quality Conditions - Given a Geolocation.
description: Returns historical air quality conditions. See https://www.weatherbit.io/api for API specific rate limits.
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 92.56
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 53.13
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
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'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/current/airquality:
get:
tags:
- Current Air Quality
summary: Weatherbit Returns Current Air Quality Conditions - Given a Geolocation.
description: Returns current air quality conditions.
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 1.36
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 36.08
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
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'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/forecast/hourly:
get:
tags:
- 240 Hour / Hourly Forecast
summary: Weatherbit Returns an Hourly Forecast - Given a Lat/lon.
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:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 86.82
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 7.04
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: station
in: query
description: Station Call ID.
schema:
type: string
format: string
example: example-value
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: I
- name: lang
in: query
description: "Language (Default: English) See language field description"
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
example: fr
- name: hours
in: query
description: Number of hours to return.
schema:
type: integer
format: integer
example: 71
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
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'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/forecast/agweather:
get:
tags:
- AgWeather Forecast
summary: Weatherbit Returns Agweather Forecast - Given a Lat/lon.
description: "Returns Agweather Forecast - Given a lat, and lon. See https://www.weatherbit.io/api for API specific rate limits."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 34.18
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 56.54
- name: start_date
in: query
description: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: end_date
in: query
description: End Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: I
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
"200":
description: An AGWeather Forecast Data Object.
content:
application/json:
schema:
$ref: '#/components/schemas/ForecastAG'
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/history/agweather:
get:
tags:
- Historical AgWeather Data
summary: Weatherbit Returns Historical Agweather - Given a Lat/lon.
description: "Returns Historical Agweather Observations - Given a lat, and lon. See https://www.weatherbit.io/api for API specific rate limits."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 41.08
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 16.98
- name: start_date
in: query
description: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: end_date
in: query
description: End Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: tp
in: query
description: "Time period of calculation (daily [DEFAULT], or hourly)."
required: true
schema:
type: string
format: string
enum:
- daily
- hourly
example: hourly
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: I
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
"200":
description: An AGWeather Historical Data Object.
content:
application/json:
schema:
$ref: '#/components/schemas/HistoryAG'
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/normals:
get:
tags:
- Climate Normals (Averages)
summary: Weatherbit Returns Historical Climate Normals (Averages) - Given a Lat/lon.
description: "Returns Historical Climate Normals (Averages) - Given a lat, and lon. See https://www.weatherbit.io/api for API specific rate limits."
parameters:
- name: lat
in: query
description: Latitude component of location.
required: true
schema:
type: number
format: double
example: 8.25
- name: lon
in: query
description: Longitude component of location.
required: true
schema:
type: number
format: double
example: 21.65
- name: start_day
in: query
description: Start Day (MM-DD).
required: true
schema:
type: string
format: string
example: example-value
- name: end_day
in: query
description: End Day (MM-DD).
required: true
schema:
type: string
format: string
example: example-value
- name: tp
in: query
description: "Time period of calculation (daily, monthly, or hourly)."
required: true
schema:
type: string
format: string
enum:
- daily
- hourly
- monthly
example: daily
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: S
- name: series_year
in: query
description: Series year for calculation. 2020 for 1991-2020. 2010 for 1981-2010.
required: true
schema:
type: number
format: number
example: 73.0
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
"200":
description: An Normals Data Object.
content:
application/json:
schema:
$ref: '#/components/schemas/Normals'
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/history/daily:
get:
tags:
- Daily Historical Weather Data
summary: Weatherbit Returns Historical Observations - Given a Lat/lon.
description: "Returns Historical Observations - Given a lat, and lon. See https://www.weatherbit.io/api for API specific rate limits."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 35.05
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 36.94
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: station
in: query
description: Station Call ID.
schema:
type: string
format: string
example: example-value
- name: start_date
in: query
description: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: end_date
in: query
description: End Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: I
- name: lang
in: query
description: "Language (Default: English) See language field description"
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
example: uk
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
"200":
description: An Historical Day Data Object.
content:
application/json:
schema:
$ref: '#/components/schemas/HistoryDay'
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/history/hourly:
get:
tags:
- Hourly Historical Weather Data
summary: Weatherbit Returns Historical Observations - Given a Lat/lon.
description: "Returns Historical Observations - Given a lat, and lon. See https://www.weatherbit.io/api for API specific rate limits."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 64.13
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 38.01
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: station
in: query
description: Station Call ID.
schema:
type: string
format: string
example: example-value
- name: start_date
in: query
description: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: end_date
in: query
description: End Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: S
- name: lang
in: query
description: "Language (Default: English) See language field description"
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
example: sv
- name: tz
in: query
description: "Assume utc (default) or local time for start_date, end_date"
schema:
type: string
format: string
enum:
- local
- utc
example: local
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
"200":
description: An Historical Data Object.
content:
application/json:
schema:
$ref: '#/components/schemas/History'
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/history/subhourly:
get:
tags:
- Sub-Hourly Historical Weather Data
summary: Weatherbit Returns Historical Observations - Given a Lat/lon.
description: "Returns Historical Observations - Given a lat, and lon. See https://www.weatherbit.io/api for API specific rate limits."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 28.4
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 47.75
- name: city_id
in: query
description: "City ID. Example: 4487042"
schema:
type: string
format: string
example: Kansas City
- name: city
in: query
description: "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR"
schema:
type: string
format: string
example: Kansas City
- name: postal_code
in: query
description: "Postal Code. Example: 28546"
schema:
type: string
format: string
example: example-value
- name: country
in: query
description: Country Code (2 letter) - to be used with postal_code.
schema:
type: string
format: string
example: US
- name: station
in: query
description: Station Call ID.
schema:
type: string
format: string
example: example-value
- name: start_date
in: query
description: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: end_date
in: query
description: End Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: S
- name: lang
in: query
description: "Language (Default: English) See language field description"
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
example: hr
- name: tz
in: query
description: "Assume utc (default) or local time for start_date, end_date"
schema:
type: string
format: string
enum:
- local
- utc
example: local
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
"200":
description: An Historical Data Object.
content:
application/json:
schema:
$ref: '#/components/schemas/HistorySubhourly'
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/forecast/energy:
get:
tags:
- Forecast Degree Day API
summary: 'Weatherbit Returns Energy Forecast API Response - Given a Single Lat/lon.'
description: "Retrieve an 8 day forecast relevant to te Energy Sector (degree days, solar radiation, precipitation, wind)."
parameters:
- name: lat
in: query
description: Latitude component of location.
schema:
type: number
format: double
example: 35.45
- name: lon
in: query
description: Longitude component of location.
schema:
type: number
format: double
example: 8.17
- name: threshold
in: query
description: 'Temperature threshold to use to calculate degree days (default 18 C) '
schema:
type: number
format: double
example: 59.44
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: I
- name: tp
in: query
description: "Time period (default: daily)"
schema:
type: string
format: string
enum:
- hourly
- daily
example: daily
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
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'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/history/energy:
get:
tags:
- Historical Degree Day API
summary: 'Weatherbit Returns Energy API Response - Given a Single Lat/lon.'
description: "Returns aggregate energy specific historical weather fields, over a specified time period. See https://www.weatherbit.io/api for API specific rate limits."
parameters:
- name: lat
in: query
description: Latitude component of location.
required: true
schema:
type: number
format: double
example: 74.69
- name: lon
in: query
description: Longitude component of location.
required: true
schema:
type: number
format: double
example: 61.34
- name: start_date
in: query
description: Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: end_date
in: query
description: End Date (YYYY-MM-DD or YYYY-MM-DD:HH).
required: true
schema:
type: string
format: string
example: example-value
- name: tp
in: query
description: "Time period to aggregate by (daily, monthly)"
schema:
type: string
format: string
enum:
- hourly
- daily
- monthly
example: monthly
- name: threshold
in: query
description: 'Temperature threshold to use to calculate degree days (default 18 C) '
schema:
type: number
format: double
example: 22.57
- name: units
in: query
description: Convert to units. Default Metric See units field description
schema:
type: string
format: string
enum:
- S
- I
example: S
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
"200":
description: An Energy Data Object.
content:
application/json:
schema:
$ref: '#/components/schemas/EnergyObsGroup'
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/bulk/files:
get:
tags:
- Bulk Downloads
summary: Weatherbit Download Pre-generated Bulk Datasets
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:
- name: file
in: path
description: Filename (ie. current.csv.gz)
required: true
schema:
type: string
format: string
example: example-value
- name: key
in: query
description: Your registered API key.
required: true
schema:
type: string
format: string
example: abc123xyz
responses:
default:
description: No Data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
ForecastHour:
type: object
properties:
ts:
type: number
description: Unix Timestamp
example: 1551718800
timestamp_local:
type: string
description: Timestamp in local time
example: 2019-03-04T12:00:00
timestamp_utc:
type: string
description: Timestamp UTC
example: 2019-03-04T17:00:00
datetime:
type: string
description: Date in format "YYYY-MM-DD:HH". All datetime is in (UTC)
example: 2019-03-04:17
snow:
type: number
description: Accumulated snowfall since last forecast point - Default (mm)
example: 10.45
precip:
type: number
description: Accumulated precipitation since last forecast point. Default (mm)
example: 1.1
temp:
type: number
description: Temperature - Default (C)
example: -1.5
dewpt:
type: number
description: Dewpoint - Default (C)
example: -4.0
app_temp:
type: number
description: Apparent Temperature - Default (C)
example: 4.5
rh:
type: integer
description: Relative Humidity as a percentage (%)
example: 95
clouds:
type: integer
description: Cloud cover as a percentage (%)
example: 100
weather:
type: object
properties:
icon:
type: string
description: Icon code for forecast image display
example: s02d
code:
type: integer
description: Weather Condition code
example: 601
description:
type: string
description: Weather Condition description
example: Snow
slp:
type: number
description: Mean Sea level pressure (mb)
example: 1012.89
pres:
type: number
description: Pressure (mb)
example: 1005.0
uv:
type: number
description: UV Index
example: 6.5
solar_rad:
type: number
description: Estimated solar radiation (W/m^2)
example: 300.0
ghi:
type: number
description: Global horizontal solar irradiance (W/m^2)
example: 1000.0
dhi:
type: number
description: Diffuse normal solar irradiance (W/m^2)
example: 200.0
dni:
type: number
description: Direct normal solar irradiance (W/m^2)
example: 400.0
vis:
type: number
description: Visibility - Default (KM)
example: 1.0
pod:
type: string
description: "Part of day (d = day, n = night)"
example: d
pop:
type: number
description: Chance of Precipitation as a percentage (%)
example: 75.0
wind_spd:
type: number
description: Wind Speed - Default (m/s)
example: 13.85
wind_gust_spd:
type: number
description: Wind Gust Speed - Default (m/s)
example: 16.85
wind_dir:
type: integer
description: Wind direction
example: 105
wind_cdir:
type: string
description: Cardinal wind direction
example: ENE
wind_cdir_full:
type: string
description: Cardinal wind direction (text)
example: East-North-East
Forecast:
type: object
properties:
ts:
type: number
description: Unix Timestamp
example: 1551718800
timestamp_local:
type: string
description: Timestamp in local time
example: 2019-03-04T12:00:00
timestamp_utc:
type: string
description: Timestamp UTC
example: 2019-03-04T17:00:00
datetime:
type: string
description: Date in format "YYYY-MM-DD:HH". All datetime is in (UTC)
example: 2019-03-04:17
snow:
type: number
description: Accumulated snowfall since last forecast point - default (mm)
example: 10.45
precip:
type: number
description: Accumulated precipitation since last forecast point - default (mm)
example: 1.1
temp:
type: number
description: Temperature (Average) - default (C)
example: 1.0
dewpt:
type: number
description: Dewpoint (Average) - default (C)
example: 1.0
max_temp:
type: number
description: Maximum daily Temperature - default (C)
example: 1.5
min_temp:
type: number
description: Minimum daily Temperature - default (C)
example: -1.23
app_max_temp:
type: number
description: Apparent Maximum daily Temperature - default (C)
example: 4.0
app_min_temp:
type: number
description: Apparent Minimum daily Temperature - default (C)
example: -2.0
rh:
type: integer
description: Relative Humidity as a percentage (%)
example: 95
clouds:
type: integer
description: Cloud cover as a percentage (%)
example: 100
weather:
type: object
properties:
icon:
type: string
description: Icon code for forecast image display
example: s02n
code:
type: integer
description: Weather Condition code
example: 601
description:
type: string
description: Weather Condition description
example: Snow
slp:
type: number
description: Mean Sea level pressure (mb)
example: 1012.89
pres:
type: number
description: Pressure (mb)
example: 1005.0
uv:
type: number
description: UV Index
example: 6.5
vis:
type: number
description: Average Visibility default (KM)
example: 3.0
pop:
type: number
description: Chance of Precipitation as a percentage (%)
example: 75.0
moon_phase:
type: number
description: Moon phase
example: 0.87
sunrise_ts:
type: integer
description: Sunrise unix timestamp
example: 1530331260
sunset_ts:
type: integer
description: Sunset unix timestamp
example: 1530331260
moonrise_ts:
type: integer
description: Moonrise unix timestamp
example: 1530331260
moonset_ts:
type: integer
description: Moonset unix timestamp
example: 1530331260
pod:
type: string
description: "Part of the day (d = day, n = night)"
example: "n"
wind_spd:
type: number
description: Wind Speed (default m/s)
example: 13.85
wind_dir:
type: integer
description: Wind direction
example: 105
wind_cdir:
type: string
description: Cardinal wind direction
example: ENE
wind_cdir_full:
type: string
description: Cardinal wind direction (text)
example: East-North-East
HistoryObj:
type: object
properties:
ts:
type: number
description: Unix Timestamp
example: 1551718800
timestamp_local:
type: string
description: Timestamp in local time
example: 2019-03-04T12:00:00
timestamp_utc:
type: string
description: Timestamp UTC
example: 2019-03-04T17:00:00
revision_status:
type: string
description: Data revision status (interim or final)
example: final
datetime:
type: string
description: Date in format "YYYY-MM-DD:HH". All datetime is in (UTC)
example: 2019-03-04:17
slp:
type: number
description: Sea level pressure (mb)
example: 1020.1
pres:
type: number
description: Pressure (mb)
example: 845.0
rh:
type: integer
description: Relative Humidity as a percentage (%)
example: 85
dewpt:
type: number
description: Dew point (Default Celcius)
example: -1.5
temp:
type: number
description: Temperature (Default Celcius)
example: -1.2
app_temp:
type: number
description: Apparent Temperature or Wind Chill/Heat Index (Default Celcius)
example: -1.5
wind_spd:
type: number
description: Wind Speed (Default m/s)
example: 14.7
wind_gust_spd:
type: number
description: Wind Gust Speed - Default (m/s)
example: 16.85
wind_dir:
type: integer
description: Wind direction (Degrees)
example: 325
uv:
type: number
description: UV Index (1-11+)
example: 4.0
solar_rad:
type: number
description: Estimated solar radiation (W/m^2)
example: 300.0
ghi:
type: number
description: Global horizontal solar irradiance (W/m^2)
example: 1500.0
dhi:
type: number
description: Diffuse normal solar irradiance (W/m^2)
example: 200.0
dni:
type: number
description: Direct normal solar irradiance (W/m^2)
example: 400.0
elev_angle:
type: number
description: Solar elevation angle (Degrees)
example: 27.5
azimuth:
type: number
description: Azimuth angle (Degrees)
example: 50.5
vis:
type: number
description: Visibility (KM)
example: 10.0
pod:
type: string
description: "Part of the day (d = day, n = night)"
example: "n"
weather:
type: object
properties:
icon:
type: string
description: Icon code for forecast image display
example: s01n
code:
type: integer
description: Weather Condition code
example: 601
description:
type: string
description: Weather Condition description
example: Light Snow
clouds:
type: integer
description: Cloud Cover 0-100 (%)
example: 50
precip:
type: number
description: Liquid equivalent precipitation - Default (mm)
example: 3.0
snow:
type: number
description: Snowfall - Default (mm)
example: 30.0
ForecastAG:
type: object
properties:
lat:
type: number
description: Latitude
example: 47.61
lon:
type: number
description: Longitude
example: -122.33
data:
type: array
items:
$ref: '#/components/schemas/HistoryAGObj'
HistoryAG:
type: object
properties:
lat:
type: number
description: Latitude
example: 47.61
lon:
type: number
description: Longitude
example: -122.33
data:
type: array
items:
$ref: '#/components/schemas/HistoryAGObj'
HistoryAGObj:
type: object
properties:
bulk_soil_density:
type: number
description: Bulk Soil Density
example: 1370.0
dlwrf_avg:
type: number
description: Average Downward Longwave Radiation Flux
example: 418.656
dlwrf_max:
type: number
description: Maximum Downward Longwave Radiation Flux
example: 440.25
dlwrf_net:
type: number
description: Net Downward Longwave Radiation Flux
example: 143.0
dswrf_avg:
type: number
description: Average Downward Shortwave Radiation Flux
example: 158.848
dswrf_max:
type: number
description: Maximum Downward Shortwave Radiation Flux
example: 492.25
dswrf_net:
type: number
description: Net Downward Shortwave Radiation Flux
example: -50.832
evapotranspiration:
type: number
description: Evapotranspiration
example: 4.247
precip:
type: number
description: Precipitation
example: 18.5
pres_avg:
type: number
description: Average Pressure
example: 1011.644
revision_status:
type: string
description: Data revision status
example: final
skin_temp_avg:
type: number
description: Average Skin Temperature
example: 29.4
skin_temp_max:
type: number
description: Maximum Skin Temperature
example: 40.4
skin_temp_min:
type: number
description: Minimum Skin Temperature
example: 25.4
soilm_0_10cm:
type: number
description: Soil Moisture (0-10cm depth)
example: 25.697
soilm_100_200cm:
type: number
description: Soil Moisture (100-200cm depth)
example: 273.625
soilm_10_40cm:
type: number
description: Soil Moisture (10-40cm depth)
example: 72.813
soilm_40_100cm:
type: number
description: Soil Moisture (40-100cm depth)
example: 152.203
soilt_0_10cm:
type: number
description: Soil Temperature (0-10cm depth)
example: 29.5
soilt_100_200cm:
type: number
description: Soil Temperature (100-200cm depth)
example: 24.4
soilt_10_40cm:
type: number
description: Soil Temperature (10-40cm depth)
example: 29.8
soilt_40_100cm:
type: number
description: Soil Temperature (40-100cm depth)
example: 27.7
specific_humidity:
type: number
description: Specific Humidity
example: 0.014513969421387
timestamp_local:
type: string
description: Timestamp in local time
example: 2023-09-08T00:00:00
timestamp_utc:
type: string
description: Timestamp UTC
example: 2023-09-08T00:00:00
temp_2m_avg:
type: number
description: Average Temperature at 2 meters
example: 26.6
v_soilm_0_10cm:
type: number
description: Volumetric Soil Moisture (0-10cm depth)
example: 0.257
v_soilm_100_200cm:
type: number
description: Volumetric Soil Moisture (100-200cm depth)
example: 0.274
v_soilm_10_40cm:
type: number
description: Volumetric Soil Moisture (10-40cm depth)
example: 0.243
v_soilm_40_100cm:
type: number
description: Volumetric Soil Moisture (40-100cm depth)
example: 0.254
valid_date:
type: string
description: Valid Date
example: 2023-09-08
wind_10m_spd_avg:
type: number
description: Average Wind Speed at 10 meters
example: 2.505
ForecastAGObj:
type: object
properties:
bulk_soil_density:
type: number
description: Bulk Soil Density
example: 1370.0
dlwrf_avg:
type: number
description: Average Downward Longwave Radiation Flux
example: 418.656
dlwrf_max:
type: number
description: Maximum Downward Longwave Radiation Flux
example: 440.25
dlwrf_net:
type: number
description: Net Downward Longwave Radiation Flux
example: 143.0
dswrf_avg:
type: number
description: Average Downward Shortwave Radiation Flux
example: 158.848
dswrf_max:
type: number
description: Maximum Downward Shortwave Radiation Flux
example: 492.25
dswrf_net:
type: number
description: Net Downward Shortwave Radiation Flux
example: -50.832
evapotranspiration:
type: number
description: Evapotranspiration
example: 4.247
precip:
type: number
description: Precipitation
example: 18.5
pres_avg:
type: number
description: Average Pressure
example: 1011.644
revision_status:
type: string
description: Data revision status
example: final
skin_temp_avg:
type: number
description: Average Skin Temperature
example: 29.4
skin_temp_max:
type: number
description: Maximum Skin Temperature
example: 40.4
skin_temp_min:
type: number
description: Minimum Skin Temperature
example: 25.4
soilm_0_10cm:
type: number
description: Soil Moisture (0-10cm depth)
example: 25.697
soilm_100_200cm:
type: number
description: Soil Moisture (100-200cm depth)
example: 273.625
soilm_10_40cm:
type: number
description: Soil Moisture (10-40cm depth)
example: 72.813
soilm_40_100cm:
type: number
description: Soil Moisture (40-100cm depth)
example: 152.203
soilt_0_10cm:
type: number
description: Soil Temperature (0-10cm depth)
example: 29.5
soilt_100_200cm:
type: number
description: Soil Temperature (100-200cm depth)
example: 24.4
soilt_10_40cm:
type: number
description: Soil Temperature (10-40cm depth)
example: 29.8
soilt_40_100cm:
type: number
description: Soil Temperature (40-100cm depth)
example: 27.7
specific_humidity:
type: number
description: Specific Humidity
example: 0.014513969421387
temp_2m_avg:
type: number
description: Average Temperature at 2 meters
example: 26.6
v_soilm_0_10cm:
type: number
description: Volumetric Soil Moisture (0-10cm depth)
example: 0.257
v_soilm_100_200cm:
type: number
description: Volumetric Soil Moisture (100-200cm depth)
example: 0.274
v_soilm_10_40cm:
type: number
description: Volumetric Soil Moisture (10-40cm depth)
example: 0.243
v_soilm_40_100cm:
type: number
description: Volumetric Soil Moisture (40-100cm depth)
example: 0.254
valid_date:
type: string
description: Valid Date
example: 2023-09-08
wind_10m_spd_avg:
type: number
description: Average Wind Speed at 10 meters
example: 2.505
HistorySubhourlyObj:
type: object
properties:
ts:
type: number
description: Unix Timestamp
example: 1551718800
timestamp_local:
type: string
description: Timestamp in local time
example: 2019-03-04T12:15:00
timestamp_utc:
type: string
description: Timestamp UTC
example: 2019-03-04T17:15:00
revision_status:
type: string
description: Data revision status (interim or final)
example: final
slp:
type: number
description: Sea level pressure (mb)
example: 1020.1
pres:
type: number
description: Pressure (mb)
example: 845.0
rh:
type: integer
description: Relative Humidity as a percentage (%)
example: 85
dewpt:
type: number
description: Dew point (Default Celcius)
example: -1.5
temp:
type: number
description: Temperature (Default Celcius)
example: -1.2
app_temp:
type: number
description: Apparent Temperature or Wind Chill/Heat Index (Default Celcius)
example: -1.5
wind_spd:
type: number
description: Wind Speed (Default m/s)
example: 14.7
wind_gust_spd:
type: number
description: Wind Gust Speed - Default (m/s)
example: 16.85
wind_dir:
type: integer
description: Wind direction (Degrees)
example: 325
uv:
type: number
description: UV Index (1-11+)
example: 4.0
solar_rad:
type: number
description: Estimated solar radiation (W/m^2)
example: 300.0
ghi:
type: number
description: Global horizontal solar irradiance (W/m^2)
example: 1500.0
dhi:
type: number
description: Diffuse normal solar irradiance (W/m^2)
example: 200.0
dni:
type: number
description: Direct normal solar irradiance (W/m^2)
example: 400.0
elev_angle:
type: number
description: Solar elevation angle (Degrees)
example: 27.5
azimuth:
type: number
description: Solar azimuth angle (Degrees)
example: 40.5
vis:
type: number
description: Visibility (KM)
example: 10.0
pod:
type: string
description: "Part of the day (d = day, n = night)"
example: "n"
weather:
type: object
properties:
icon:
type: string
description: Icon code for forecast image display
example: s01n
code:
type: integer
description: Weather Condition code
example: 601
description:
type: string
description: Weather Condition description
example: Light Snow
clouds:
type: integer
description: Cloud Cover 0-100 (%)
example: 50
precip_rate:
type: number
description: Liquid equivalent precipitation rate - Default (mm/hr)
example: 3.0
snow_rate:
type: number
description: Snowfall Rate - Default (mm/hr)
example: 30.0
HistoryDayObj:
type: object
properties:
datetime:
type: string
description: Date in format "YYYY-MM-DD". All datetime is in (UTC)
example: 2015-01-03
ts:
type: integer
description: Unix timestamp of datetime (Midnight UTC)
example: 1501970516
revision_status:
type: string
description: Data revision status (interim or final)
example: final
slp:
type: number
description: Average sea level pressure (mb)
example: 1020.1
pres:
type: number
description: Average pressure (mb)
example: 885.1
rh:
type: number
description: Average relative humidity as a percentage (%)
example: 85.0
dewpt:
type: number
description: Average dewpoint - Default (C)
example: -1.5
temp:
type: number
description: Average temperature - Default (C)
example: 1.0
max_temp:
type: number
description: Max temperature - Default (C)
example: 1.5
max_temp_ts:
type: number
description: Time of max memperature - Unix Timestamp
example: 1501970816
min_temp:
type: number
description: Min temperature - Default (C)
example: 11.7
min_temp_ts:
type: number
description: Time of max temperature - unix timestamp
example: 1501970516
wind_spd:
type: number
description: Average wind speed - default (m/s)
example: 14.98
wind_dir:
type: integer
description: Average wind direction (degrees)
example: 325
wind_gust_spd:
type: number
description: Wind gust speed - default (m/s)
example: 40.98
max_wind_spd:
type: number
description: Max 2min Wind Speed - default (m/s)
example: 19.98
max_wind_dir:
type: integer
description: Direction of wind at time of max 2min wind (degrees)
example: 325
max_wind_spd_ts:
type: number
description: Time of max 2min wind - unix timestamp
example: 1501970516
ghi:
type: integer
description: Average hourly global horizontal solar irradiance (W/m^2)
example: 125
t_ghi:
type: integer
description: Total global horizontal solar irradiance (W/m^2)
example: 4500
dni:
type: integer
description: Average direct normal solar irradiance (W/m^2)
example: 125
t_dni:
type: integer
description: Total direct normal solar irradiance (W/m^2)
example: 4500
dhi:
type: integer
description: Average hourly diffuse horizontal solar irradiance (W/m^2)
example: 125
t_dhi:
type: integer
description: Total diffuse horizontal solar irradiance (W/m^2)
example: 4500
max_uv:
type: number
description: Max UV Index (1-11+)
example: 6.0
precip:
type: number
description: Liquid equivalent precipitation - default (mm)
example: 3.0
precip_gpm:
type: number
description: Satellite estimated liquid equivalent precipitation - default (mm)
example: 3.0
snow:
type: number
description: Snowfall - default (mm)
example: 30.0
NormalsObj:
type: object
properties:
month:
type: number
description: Month number
example: 2.0
temp:
type: number
description: Average temperature
example: 30.0
dewpt:
type: number
description: Average dew point
example: 25.0
max_wind_spd:
type: number
description: Maximum wind speed
example: 5.0
min_wind_spd:
type: number
description: Minimum wind speed
example: 0.0
wind_spd:
type: number
description: Average wind speed
example: 2.0
wind_dir:
type: number
description: Average wind direction
example: 200.0
precip:
type: number
description: Average Liquid equivalent precipitation - Default (mm)
example: 3.1
snow:
type: number
description: Average Snowfall - Default (mm)
example: 30.5
Normals:
type: object
properties:
timezone:
type: string
description: Local IANA time zone
example: America/New_York
sources:
type: array
description: List of data sources used in response
items:
type: string
example: era5
data:
type: array
items:
$ref: '#/components/schemas/NormalsObj'
ForecastDay:
type: object
properties:
city_name:
type: string
description: City Name
example: Raleigh
state_code:
type: string
description: State Abbreviation
example: NC
country_code:
type: string
description: Country Abbreviation
example: US
lat:
type: number
description: Latitude
example: 38.25
lon:
type: number
description: Longitude
example: -78.0
timezone:
type: string
description: Local IANA time zone
example: America/New_York
data:
type: array
items:
$ref: '#/components/schemas/Forecast'
ForecastHourly:
type: object
properties:
city_name:
type: string
description: City Name
example: Raleigh
state_code:
type: string
description: State Abbreviation
example: NC
country_code:
type: string
description: Country Abbreviation
example: US
lat:
type: number
description: Latitude
example: 38.25
lon:
type: number
description: Longitude
example: -78.0
timezone:
type: string
description: Local IANA time zone
example: America/New_York
data:
type: array
items:
$ref: '#/components/schemas/ForecastHour'
AQCurrent:
type: object
properties:
aqi:
type: integer
description: Cloud cover as a percentage (%)
example: 100
so2:
type: number
description: Concentration of SO2 (µg/m³)
example: 50.0
no2:
type: number
description: Concentration of NO2 (µg/m³)
example: 25.0
o3:
type: number
description: Concentration of O3 (µg/m³)
example: 2.0
pm25:
type: number
description: Concentration of PM 2.5 (µg/m³)
example: 230.0
pm10:
type: number
description: Concentration of PM 10 (µg/m³)
example: 150.0
AQCurrentGroup:
type: object
properties:
city_name:
type: string
description: City Name
example: Raleigh
state_code:
type: string
description: State Abbreviation
example: NC
country_code:
type: string
description: Country Abbreviation
example: US
lat:
type: number
description: Latitude
example: 38.25
lon:
type: number
description: Longitude
example: -78.0
timezone:
type: string
description: Local IANA time zone
example: America/New_York
data:
type: array
items:
$ref: '#/components/schemas/AQCurrent'
AQHour:
type: object
properties:
ts:
type: number
description: Unix Timestamp
example: 1551718800
timestamp_local:
type: string
description: Timestamp in local time
example: 2019-03-04T12:00:00
timestamp_utc:
type: string
description: Timestamp UTC
example: 2019-03-04T17:00:00
aqi:
type: integer
description: Cloud cover as a percentage (%)
example: 100
so2:
type: number
description: Concentration of SO2 (µg/m³)
example: 50.0
no2:
type: number
description: Concentration of NO2 (µg/m³)
example: 25.0
o3:
type: number
description: Concentration of O3 (µg/m³)
example: 2.0
pm25:
type: number
description: Concentration of PM 2.5 (µg/m³)
example: 230.0
pm10:
type: number
description: Concentration of PM 10 (µg/m³)
example: 150.0
AQHourly:
type: object
properties:
city_name:
type: string
description: City Name
example: Raleigh
state_code:
type: string
description: State Abbreviation
example: NC
country_code:
type: string
description: Country Abbreviation
example: US
lat:
type: number
description: Latitude
example: 38.25
lon:
type: number
description: Longitude
example: -78.0
timezone:
type: string
description: Local IANA time zone
example: America/New_York
data:
type: array
items:
$ref: '#/components/schemas/AQHour'
FCMinutelyOb:
type: object
properties:
timestamp_utc:
type: string
description: Full time (UTC) of forecast point (YYYY-MM-DD HH:MM)
example: 2017-03-15 13:11
timestamp_local:
type: string
description: Full local time of forecast point (YYYY-MM-DD HH:MM)
example: 2017-03-15 13:11
ts:
type: number
description: Unix Timestamp
example: 1551718800
precip:
type: number
description: Precipitation rate - Default (mm/hr)
example: 2.0
temp:
type: number
description: Temperature - Default (C)
example: 13.85
snow:
type: number
description: Snowfall rate - Default (mm/hr)
example: 10.0
FCMinutely:
type: object
properties:
city_name:
type: string
description: City Name
example: Raleigh
state_code:
type: string
description: State Abbreviation
example: NC
country_code:
type: string
description: Country Abbreviation
example: US
lat:
type: number
description: Latitude
example: 38.25
lon:
type: number
description: Longitude
example: -78.0
timezone:
type: string
description: Local IANA time zone
example: America/New_York
data:
type: array
items:
$ref: '#/components/schemas/FCMinutelyOb'
CurrentObs:
type: object
properties:
city_name:
type: string
description: City name (closest)
example: Raleigh
state_code:
type: string
description: State abbreviation
example: NC
country_code:
type: string
description: Country abbreviation
example: US
timezone:
type: string
description: Local IANA time zone
example: America/New_York
lat:
type: number
description: Latitude
example: 38.0
lon:
type: number
description: Longitude
example: -78.25
station:
type: string
description: Source Station ID
example: KRDU
sources:
type: array
description: List of data sources used in response
items:
type: string
example: rtma
vis:
type: integer
description: Visibility - default (M)
example: 10000
rh:
type: integer
description: Relative humidity (%)
example: 75
dewpt:
type: number
description: Dew point temperature - default (C)
example: 12.0
wind_dir:
type: integer
description: Wind direction (degrees)
example: 125
wind_cdir:
type: string
description: Cardinal wind direction
example: ENE
wind_cdir_full:
type: string
description: Cardinal wind direction (text)
example: East-North-East
wind_speed:
type: number
description: Wind speed - Default (m/s)
example: 5.85
temp:
type: number
description: Temperature - Default (C)
example: 13.85
app_temp:
type: number
description: Apparent temperature - Default (C)
example: 14.85
clouds:
type: integer
description: Cloud cover (%)
example: 42
weather:
type: object
properties:
icon:
type: string
description: Icon code for forecast image display
example: c02
code:
type: integer
description: Weather Condition code
example: 802
description:
type: string
description: Weather Condition description
example: Broken clouds
datetime:
type: string
description: Cycle Hour (UTC) of observation
example: 2017-03-15:13
ob_time:
type: string
description: Full time (UTC) of observation (YYYY-MM-DD HH:MM)
example: 2017-03-15 13:11
ts:
type: number
description: Unix Timestamp
example: 1490990400
sunrise:
type: string
description: Time (UTC) of Sunrise (HH:MM)
example: 06:22
sunset:
type: string
description: Time (UTC) of Sunset (HH:MM)
example: 19:34
slp:
type: number
description: Mean sea level pressure in millibars (mb)
example: 1013.12
pres:
type: number
description: Pressure (mb)
example: 1010.0
aqi:
type: number
description: Air quality index (US EPA standard 0 to +500)
example: 50.0
uv:
type: number
description: UV Index
example: 6.5
solar_rad:
type: number
description: Estimated solar radiation (W/m^2)
example: 300.4
ghi:
type: number
description: Global horizontal irradiance (W/m^2)
example: 450.4
dni:
type: number
description: Direct normal irradiance (W/m^2)
example: 450.4
dhi:
type: number
description: Diffuse horizontal irradiance (W/m^2)
example: 450.4
elev_angle:
type: number
description: Current solar elevation angle (Degrees)
example: 37.0
pod:
type: string
description: "Part of the day (d = day, n = night)"
precip:
type: number
description: Precipitation in last hour - Default (mm)
example: 2.0
snow:
type: number
description: Snowfall in last hour - Default (mm)
example: 10.0
CurrentObsGroup:
type: object
properties:
count:
type: integer
description: Count of found observations
example: 1
data:
type: array
items:
$ref: '#/components/schemas/CurrentObs'
EnergyObsSeries:
type: object
properties:
date:
type: string
description: Date
example: 2018-06-01
cdd:
type: number
description: Cooling degree days
example: 10.0
hdd:
type: number
description: Heating degree days
example: 120.0
rh:
type: integer
description: Average Relative humidity (%)
example: 75
dewpt:
type: number
description: Average dew point temperature - Default (C)
example: 12.0
wind_dir:
type: integer
description: Average wind direction (Degrees)
example: 125
wind_spd:
type: number
description: Average wind speed - Default (m/s)
example: 5.85
temp:
type: number
description: Average temperature - Default (C)
example: 13.85
clouds:
type: integer
description: Average cloud cover (%)
example: 42
t_ghi:
type: number
description: Total global horizontal solar irradiance (W/m^2)
example: 3000.0
t_dhi:
type: number
description: Total diffuse horizontal solar irradiance (W/m^2)
example: 450.0
t_dni:
type: number
description: Total direct normal solar irradiance (W/m^2)
example: 1200.0
sun_hours:
type: number
description: "Average number of daily sun hours - # hours where Solar GHI > 1000 W/m^2"
example: 4.5
precip:
type: number
description: Total precipitation in period - Default (mm)
example: 2.0
snow:
type: number
description: Total snowfall in period - Default (mm)
example: 10.0
EnergyObs:
type: object
properties:
city_name:
type: string
description: City name (closest)
example: Raleigh
state_code:
type: string
description: State abbreviation
example: NC
country_code:
type: string
description: Country abbreviation
example: US
timezone:
type: string
description: Local IANA time zone
example: America/New_York
lat:
type: number
description: Latitude
example: 38.0
lon:
type: number
description: Longitude
example: -78.25
station_id:
type: string
description: "Nearest Station ID [DEPRECATED]"
example: 12345-999999
sources:
type: array
description: List of data sources used in response
items:
type: string
example: 12345-89083
cdd:
type: number
description: Cooling degree days
example: 10.0
hdd:
type: number
description: Heating degree days
example: 120.0
rh:
type: integer
description: Average Relative humidity (%)
example: 75
dewpt:
type: number
description: Average dew point temperature - Default (C)
example: 12.0
wind_dir:
type: integer
description: Average wind direction (Degrees)
example: 125
wind_spd:
type: number
description: Average wind speed - Default (m/s)
example: 5.85
temp:
type: number
description: Average temperature - Default (C)
example: 13.85
clouds:
type: integer
description: Average cloud cover (%)
example: 42
t_ghi:
type: number
description: Total global horizontal solar irradiance (W/m^2)
example: 3000.0
t_dhi:
type: number
description: Total diffuse horizontal solar irradiance (W/m^2)
example: 450.0
t_dni:
type: number
description: Total direct normal solar irradiance (W/m^2)
example: 1200.0
sun_hours:
type: number
description: "Average number of daily sun hours - # hours where Solar GHI > 1000 W/m^2"
example: 4.5
precip:
type: number
description: Total precipitation in period - Default (mm)
example: 2.0
snow:
type: number
description: Total snowfall in period - Default (mm)
example: 10.0
WeatherAlert:
type: object
properties:
lat:
type: number
description: Latitude
example: 38.0
lon:
type: number
description: Longitude
example: -78.25
alerts:
type: array
items:
$ref: '#/components/schemas/WeatherAlertGroup'
WeatherAlertGroup:
type: object
properties:
title:
type: string
description: Brief description of weather alert
example: Flood Warning issued February 8 at 8:51PM CST expiring February 12 at 8:24AM CST by NWS St Louis MO
description:
type: string
description: Full description of weather alert
example: |-
Mississippi River at Chester
.This Flood Warning is a result of 1-2 inches of rainfall across
the basin earlier this week...
The Flood Warning continues for
the Mississippi River at Chester
* until Tuesday morning.
* At 8:30 PM Friday the stage was 26.8 feet.
* Flood stage is 27.0 feet.
* Minor flooding is forecast.
* The river is forecast to rise above flood stage by tonight and to
crest near 29.0 feet by Saturday evening. The river is forecast to
fall below flood stage by Monday morning.
* Impact: At 28.0 feet...Unleveed islands near Chester and the prison
farm floods.
* Impact: At 27.0 feet...Flood Stage. Unprotected farmland on right
bank begins to flood.
severity:
type: string
description: Severity of weather. (Advisory | Watch | Warning)
example: Warning
effective_utc:
type: string
description: Issued time UTC
example: 2019-02-09T02:51:00
effective_local:
type: string
description: Issued time local
example: 2019-02-08T21:51:00
expires_utc:
type: string
description: Expiration time UTC
example: 2019-02-10T02:51:00
expires_local:
type: string
description: Expiration time local
example: 2019-02-09T21:51:00
uri:
type: string
description: URI to weather alert
example: https://api.weather.gov/alerts/NWS-IDP-PROD-3361975-2942026
alerts:
type: array
items:
$ref: '#/components/schemas/AlertRegionGroup'
AlertRegionGroup:
type: string
description: List of impacted regions
example: "St Louis, MO"
EnergyObsGroup:
type: object
properties:
count:
type: integer
description: Count of found observations
example: 1
start_date:
type: integer
description: Start Date
end_date:
type: integer
description: End Date
data:
type: array
items:
$ref: '#/components/schemas/EnergyObs'
EnergyObsGroupForecast:
type: object
properties:
city_name:
type: string
description: City name (closest)
example: Raleigh
state_code:
type: string
description: State abbreviation
example: NC
country_code:
type: string
description: Country abbreviation
example: US
timezone:
type: string
description: Local IANA time zone
example: America/New_York
lat:
type: number
description: Latitude
example: 38.0
lon:
type: number
description: Longitude
example: -78.25
threshold_units:
type: string
description: Degree day threshold units
example: C
threshold_value:
type: string
description: Degree day threshold
example: "18"
data:
type: array
items:
$ref: '#/components/schemas/EnergyObsSeries'
History:
type: object
properties:
city_name:
type: string
description: City name (Closest)
example: Seattle
state_code:
type: string
description: State abbreviation
example: WA
country_code:
type: string
description: Country abbreviation
example: US
timezone:
type: string
description: Local IANA time zone
example: America/New_York
lat:
type: number
description: Latitude
example: 47.61
lon:
type: number
description: Longitude
example: -122.33
sources:
type: array
description: List of data sources used in response
items:
type: string
example: 12345-89083
data:
type: array
items:
$ref: '#/components/schemas/HistoryObj'
HistorySubhourly:
type: object
properties:
city_name:
type: string
description: City name (Closest)
example: Seattle
state_code:
type: string
description: State abbreviation
example: WA
country_code:
type: string
description: Country abbreviation
example: US
timezone:
type: string
description: Local IANA time zone
example: America/New_York
lat:
type: number
description: Latitude
example: 47.61
lon:
type: number
description: Longitude
example: -122.33
sources:
type: array
description: List of data sources used in response
items:
type: string
example: 12345-89083
data:
type: array
items:
$ref: '#/components/schemas/HistoryObj'
HistoryDay:
type: object
properties:
city_name:
type: string
description: City name (Closest)
example: Seattle
state_code:
type: string
description: State abbreviation
example: WA
country_code:
type: string
description: Country abbreviation
example: US
timezone:
type: string
description: Local IANA time zone
example: America/New_York
lat:
type: number
description: Latitude
example: 47.61
lon:
type: number
description: Longitude
example: -122.33
sources:
type: array
description: List of data sources used in response
items:
type: string
example: 12345-89083
data:
type: array
items:
$ref: '#/components/schemas/HistoryDayObj'
Error:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
tags:
- name: 16 Day / Daily Forecast
- name: 240 Hour / Hourly Forecast
- name: 60 Minute Rain/Snow Nowcast
- name: AgWeather Forecast
- name: Air Quality Forecast
- name: Alerts
- name: Bulk Downloads
- name: Climate Normals (Averages)
- name: Current Air Quality
- name: Current Weather Data
- name: Daily Historical Weather Data
- name: Forecast Degree Day API
- name: Historical AgWeather Data
- name: Historical Air Quality
- name: Historical Degree Day API
- name: Hourly Historical Weather Data
- name: Sub-Hourly Historical Weather Data