openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 129 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"x-twitter":"weatherbitio"},"description":"This is the documentation for the Weatherbit Weather 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 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](https://www.weatherbit.io/api) for additional documentation.","title":"Weatherbit.io - Swagger UI Weather API documentation","version":"2.0.0","x-apisguru-categories":["location"],"x-logo":{"url":"https://twitter.com/weatherbitio/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://www.weatherbit.io/static/swagger.json","version":"2.0"}],"x-providerName":"weatherbit.io"},"paths":{"/alerts?lat={lat}&lon={lon}":{"get":{"description":"Returns severe weather alerts issued by meteorological agencies - given a lat, and a lon.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Weather Alert Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherAlert"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns severe weather alerts issued by meteorological agencies - Given a lat/lon.","tags":["Alerts"]}},"/bulk/files/{file}":{"get":{"description":"**(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).","parameters":[{"description":"Filename (ie. current.json.gz)","in":"path","name":"file","required":true,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Download pre-generated bulk datasets","tags":["Bulk Downloads"]}},"/bulk/history/daily?city={city}&country={country}":{"get":{"description":"Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Day Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given City and/or State, Country.","tags":["(Bulk) Daily Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/daily?city_id={city_id}":{"get":{"description":"Returns Historical Observations - Given a City ID.","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Day Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given a City ID","tags":["(Bulk) Daily Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/daily?ip={ip}":{"get":{"description":"Returns Historical Observations - Given IP Address, or auto.","parameters":[{"description":"IP Address, or auto. Example: ip=auto","in":"path","name":"ip","required":true,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Day Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given IP Address, or auto.","tags":["(Bulk) Daily Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/daily?lat={lat}&lon={lon}":{"get":{"description":"Returns Historical Observations - Given a lat, and lon.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Day Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given a lat/lon.","tags":["(Bulk) Daily Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/daily?postal_code={postal_code}":{"get":{"description":"Returns Historical Observations - Given a Postal Code.","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Day Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given a Postal Code","tags":["(Bulk) Daily Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/daily?station={station}":{"get":{"description":"Returns Historical Observations - Given a station ID.","parameters":[{"description":"Station ID.","in":"path","name":"station","required":true,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Day Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryDay"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given a station ID.","tags":["(Bulk) Daily Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/hourly?city={city}&country={country}":{"get":{"description":"Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/History"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given City and/or State, Country. (1 Year/call limit)","tags":["(Bulk) Hourly Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/hourly?city_id={city_id}":{"get":{"description":"Returns Historical Observations - Given a City ID.","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/History"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given a City ID. (1 Year/call limit)","tags":["(Bulk) Hourly Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/hourly?ip={ip}":{"get":{"description":"Returns Historical Observations - Given IP Address, or auto.","parameters":[{"description":"IP Address, or auto. Example: ip=auto","in":"path","name":"ip","required":true,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/History"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given IP Address, or auto. (1 Year/call limit)","tags":["(Bulk) Hourly Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/hourly?lat={lat}&lon={lon}":{"get":{"description":"Returns Historical Observations - Given a lat, and lon.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/History"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given a lat/lon. (1 Year/call limit)","tags":["(Bulk) Hourly Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/hourly?postal_code={postal_code}":{"get":{"description":"Returns Historical Observations - Given a Postal Code. ","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/History"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given a Postal Code. (1 Year/call limit)","tags":["(Bulk) Hourly Historical Weather Data (Enterprise Plans)"]}},"/bulk/history/hourly?station={station}":{"get":{"description":"Returns Historical Observations - Given a station ID.","parameters":[{"description":"Station ID.","in":"path","name":"station","required":true,"schema":{"type":"string","format":"string"}},{"description":"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"start_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"End Date (YYYY-MM-DD or YYYY-MM-DD:HH).","in":"query","name":"end_date","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Historical Data Object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/History"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"[Enterprise Plan Only] Returns Historical Observations - Given a station ID. (1 Year/call limit)","tags":["(Bulk) Hourly Historical Weather Data (Enterprise Plans)"]}},"/current?cities={cities}":{"get":{"description":"Returns a group of Current Observations - Given a list of City IDs. ","parameters":[{"description":"Comma separated list of City ID's. Example: 4487042, 4494942, 4504871","in":"path","name":"cities","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a group of observations given a list of cities","tags":["Current Weather Data"]}},"/current?city={city}&country={country}":{"get":{"description":"Returns a Current Observation - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a Current Observation - Given City and/or State, Country.","tags":["Current Weather Data"]}},"/current?city_id={city_id}":{"get":{"description":"Returns current weather observation - Given a City ID. ","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a current observation by city id.","tags":["Current Weather Data"]}},"/current?ip={ip}":{"get":{"description":"Returns a Current Observation - Given an IP address, or auto.","parameters":[{"description":"IP Address, or auto. Example: ip=auto","in":"path","name":"ip","required":true,"schema":{"type":"string","format":"string"}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a Current Observation - Given an IP address, or auto.","tags":["Current Weather Data"]}},"/current?lat={lat}&lon={lon}":{"get":{"description":"Returns a Current Observation - given a lat, and a lon.","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a Current Observation - Given a lat/lon.","tags":["Current Weather Data"]}},"/current?postal_code={postal_code}":{"get":{"description":"Returns current weather observation - Given a Postal Code. ","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Marine stations only (buoys, oil platforms, etc)","in":"query","name":"marine","required":false,"schema":{"type":"string","format":"string","enum":["t"]}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback - Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a current observation by postal code.","tags":["Current Weather Data"]}},"/current?station={station}":{"get":{"description":"Returns a Current Observation - Given a station ID.","parameters":[{"description":"Station Call ID.","in":"path","name":"station","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a Current Observation. - Given a station ID.","tags":["Current Weather Data"]}},"/current?stations={stations}":{"get":{"description":"Returns a group of Current Observations - Given a list of Station Call IDs. ","parameters":[{"description":"Comma separated list of Station Call ID's. Example: KRDU,KBFI,KVNY","in":"path","name":"stations","required":true,"schema":{"type":"string","format":"string"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"An Observation Group object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentObsGroup"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a group of observations given a list of stations","tags":["Current Weather Data"]}},"/forecast/3hourly?city={city}&country={country}":{"get":{"description":"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.\n","parameters":[{"description":"City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR","in":"path","name":"city","required":true,"schema":{"type":"string","format":"string"}},{"description":"Full name of state.","in":"query","name":"state","required":false,"schema":{"type":"string","format":"string"}},{"description":"Country Code (2 letter).","in":"path","name":"country","required":true,"schema":{"type":"string","format":"string"}},{"description":"Number of days to return. Default 5.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a 3-hourly forecast - Given City and/or State, Country.","tags":["5 day / 3 hour Forecast"]}},"/forecast/3hourly?city_id={city_id}":{"get":{"description":"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.\n","parameters":[{"description":"City ID. Example: 4487042","in":"path","name":"city_id","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Number of days to return. Default 5.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a 3-hourly forecast - Given a City ID.","tags":["5 day / 3 hour Forecast"]}},"/forecast/3hourly?ip={ip}":{"get":{"description":"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.\n","parameters":[{"description":"IP address, or auto. Example: ip=auto","in":"path","name":"ip","required":true,"schema":{"type":"string","format":"string"}},{"description":"Number of days to return. Default 16.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example: callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a 3hourly forecast - Given an IP Address, or ip=auto for automatic IP lookup.","tags":["5 day / 3 hour Forecast"]}},"/forecast/3hourly?lat={lat}&lon={lon}":{"get":{"description":"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.\n","parameters":[{"description":"Latitude component of location.","in":"path","name":"lat","required":true,"schema":{"type":"number","format":"double"}},{"description":"Longitude component of location.","in":"path","name":"lon","required":true,"schema":{"type":"number","format":"double"}},{"description":"Number of days to return. Default 5.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","name":"units","required":false,"schema":{"type":"string","format":"string","enum":["S","I"]}},{"description":"Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>","in":"query","name":"lang","required":false,"schema":{"type":"string","format":"string","enum":["ar","az","be","bg","bs","ca","cs","de","fi","fr","el","es","et","hr","hu","id","it","is","kw","nb","nl","pl","pt","ro","ru","sk","sl","sr","sv","tr","uk","zh","zh-tw"]}},{"description":"Wraps return in jsonp callback. Example - callback=func","in":"query","name":"callback","required":false,"schema":{"type":"string","format":"string"}},{"description":"Your registered API key.","in":"query","name":"key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"A forecast object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastHourly"}}}},"default":{"description":"No Data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns a 3-hourly forecast - Given a lat/lon.","tags":["5 day / 3 hour Forecast"]}},"/forecast/3hourly?postal_code={postal_code}":{"get":{"description":"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.\n","parameters":[{"description":"Postal Code. Example: 28546","in":"path","name":"postal_code","required":true,"schema":{"type":"integer","format":"integer"}},{"description":"Country Code (2 letter).","in":"query","name":"country","required":false,"schema":{"type":"string","format":"string"}},{"description":"Number of days to return. Default 5.","in":"query","name":"days","required":false,"schema":{"type":"number","format":"integer"}},{"description":"Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>","in":"query","nam