{"_id":"openweather-apis","_rev":"43-a7572e9563b10cb3a0d627b1d910d5f8","name":"openweather-apis","description":"Simple APIs to use with OpenWeatherMap.org free servicies, request a APPID on http://openweathermap.org/appid and start!","dist-tags":{"latest":"4.5.0"},"versions":{"1.0.0":{"name":"openweather-apis","version":"1.0.0","description":"simple APIs to use the basic OpenWeatherMap.org servicies ","main":"index.js","scripts":{"test":"mocha"},"repository":{"type":"git","url":"git@github.com:CICCIOSGAMINO/openweather-apis.git"},"keywords":["openweather","openweathermap","meteo","weather","weather-api","apis"],"author":{"name":"Marco Canali","email":" 16) can be found at the new package domain [@cicciosgamino/openweather-apis](https://www.npmjs.com/package/@cicciosgamino/openweather-apis)\n\n# Intro\nSimple abstraction layer for use the services offered by the OpenWeatherMap.org website through its API's. You can easy reach the weather informations you need on over 400k weather stations. For get the APPID follow the OpenWeather.org [link][3] and complete the request process.\n\n# Version details\nMain changes by version (if the first number change, old code you have written is not supported, for\nexample between version 1.x.x to version 2.x.x (I apologize for that), all minor/major/fix in: \n\nCHANGELOG.md \n\n# Installation\nLike all node packages, install and mange operation are done by npm (use the -s if you want save\nthe package in the package.json file) :\n\n```javascript\n\tnpm install openweather-apis\n\n\t// install and save in package.json\n\tnpm install openweather-apis --save\n\n\t// global installation\n\tnpm install -g openweather-apis\n```\n\n# How to Use\nInstall the package with npm, import with the require statement in the app, and start to use the apis. First\nstep is set the params for the request (request the api-key at http://openweathermap.org/register ):\n\n```javascript\n\tvar weather = require('openweather-apis')\n\n\tweather.setLang('it')\n\t// English - en, Russian - ru, Italian - it, Spanish - es (or sp),\n\t// Ukrainian - uk (or ua), German - de, Portuguese - pt,Romanian - ro,\n\t// Polish - pl, Finnish - fi, Dutch - nl, French - fr, Bulgarian - bg,\n\t// Swedish - sv (or se), Chinese Tra - zh_tw, Chinese Sim - zh (or zh_cn),\n\t// Turkish - tr, Croatian - hr, Catalan - ca\n\n\t// set city by name\n\tweather.setCity('Fairplay')\n \t// or set the coordinates (latitude,longitude)\n\tweather.setCoordinate(50.0467656, 20.0048731)\n\t// or set city by ID (recommended by OpenWeatherMap)\n\tweather.setCityId(4367872)\n\n // or set zip code\n\tweather.setZipCode(33615)\n\n\t// 'metric' 'internal' 'imperial'\n \tweather.setUnits('metric')\n\n\t// check http://openweathermap.org/appid#get for get the APPID\n \tweather.setAPPID(ownKey)\n```\n\n# Current Weather Data\nUsing the following requests to API, you can get current weather data for any location on the Earth. Current weather data are updated in real time based on data from global weather providers and more than 40,000 weather stations. Weather data is available in JSON.\n\n# Methods\nImport the module and start to use the functions :\n\n```javascript\n// get the Temperature \nweather.getTemperature(function(err, temp){\n\tconsole.log(temp)\n})\n\n// get the Atm Pressure\nweather.getPressure(function(err, pres){\n\tconsole.log(pres)\n})\n\n// get the Humidity\nweather.getHumidity(function(err, hum){\n\tconsole.log(hum)\n})\n\n// get the Description of the weather condition\nweather.getDescription(function(err, desc){\n\tconsole.log(desc)\n})\n\n// get all the JSON file returned from server (rich of info)\nweather.getAllWeather(function(err, JSONObj){\n\tconsole.log(JSONObj)\n})\n\n// Adds support for the onecall api endpoint.\nweather.getWeatherOneCall = function(err, data){\n\t\n}\n```\n\nThis function returns a complete openweathermap.org json object:\n```json\n{\n\t\"coord\":{\n\t\t\"lon\":139,\n\t\t\"lat\":35\n\t},\n\t\"sys\":{\n\t\t\"country\":\"JP\",\n\t\t\"sunrise\":1369769524,\n\t\t\"sunset\":1369821049\n\t},\n\t\"weather\":[\n\t\t{\n\t\t\t\"id\":804,\n\t\t\t\"main\":\"clouds\",\n\t\t\t\"description\":\"overcast clouds\",\n\t\t\t\"icon\":\"04n\"\n\t\t}\n\t],\n\t\"main\":{\n\t\t\"temp\":289.5,\n\t\t\"humidity\":89,\n\t\t\"pressure\":1013,\n\t\t\"temp_min\":287.04,\n\t\t\"temp_max\":292.04\n\t},\n\t\"wind\":{\n\t\t\"speed\":7.31,\n\t\t\"deg\":187.002\n\t},\n\t\"rain\":{\n\t\t\"3h\":0\n\t},\n\t\"clouds\":{\n\t\t\"all\":92\n\t},\n\t\"dt\":1369824698,\n\t\"id\":1851632,\n\t\"name\":\"Shuzenji\",\n\t\"cod\":200\n}\n```\n\n```javascript\n// get 3 days forecast\nweather.getWeatherForecastForDays(3, function(err, obj){\n\tconsole.log(obj)\n})\n\n\n// get a simple JSON Object with temperature, humidity, pressure and description\nweather.getSmartJSON(function(err, smart){\n\tconsole.log(smart)\n})\n```\n\nThis is the simple JSON object returned by the getSmartJSON(), pretty useful ! The rain \nvalue can be zero if not measured or a mesured value. \n\n```javascript\n{\n\ttemp : 25,\n\thumidity : 88,\n\tpressure : 101325,\n\tdescription : 'sun',\n\train: 4,\n\tweathercode : 200\n}\n```\n\nthis JSON object is easy to use and is enough for a lot of possible use of the weather data, for example the\nweathercode is easy to use for build check function, draw the icons ecc, for the complete table about this code\ngo to this link on official [docs][1].\n\n\n# Geographic location\nYes, of course you can set the location to get info by the coordinates, first the latitude, second\nthe longitude. Sometimes use the coordinates are worse than the city name !\n\n```javascript\nweather.setCoordinate(50.0467656, 20.0048731)\n```\n\n\n# Error\nUse the callback to check if an error is raised on the request (HTTP server unreachable or other connection, request problem),\nyou need to handle the error on the request, for example :\n\n```javascript\nweather.getTemperature(function(err, temp){\n\tif(err) console.log(err)\n\n\t// normal execution with no error\n})\n```\n\n# Test\nThe package is tested with mocha and chai. You can find the tests in the /test folder. If you need to use more tests on the\nlibrary, open an issue on the github repo (THANKS).\n\n# 🔧 TODO\n- [ ] Basic Unit testing\n\n# License\n[GNU General Public License v3.0](https://github.com/CICCIOSGAMINO/init/blob/master/LICENSE)\n\nMade 🧑‍💻 by [@cicciosgamino](https://cicciosgamino.web.app)\n\n[3]:http://openweathermap.org/appid\n","maintainers":[{"name":"cicciosgamino","email":"marco.canali@gmail.com"}],"time":{"modified":"2023-05-16T08:53:44.130Z","created":"2014-09-11T14:24:22.405Z","1.0.0":"2014-09-11T14:24:22.405Z","1.0.1":"2014-09-11T19:01:02.464Z","1.0.2":"2014-09-11T19:05:04.770Z","1.1.0":"2014-09-20T15:02:11.888Z","1.1.1":"2014-09-20T15:09:29.330Z","2.0.0":"2014-09-20T15:17:15.806Z","2.0.1":"2014-10-08T19:52:10.737Z","2.0.2":"2015-11-02T13:50:46.273Z","2.0.7":"2015-11-02T20:49:33.772Z","2.1.0":"2015-12-25T22:56:56.024Z","2.1.5":"2016-01-01T14:35:36.994Z","2.1.7":"2016-01-01T14:40:07.920Z","3.0.0":"2016-01-03T23:08:49.347Z","3.0.2":"2016-02-06T11:46:40.701Z","3.3.0":"2017-04-02T17:29:15.121Z","3.3.1":"2017-04-02T17:35:37.875Z","3.3.2":"2017-04-02T17:41:53.943Z","3.3.5":"2017-10-05T11:23:32.790Z","4.0.0":"2019-02-14T18:11:13.353Z","4.1.0":"2019-10-21T05:26:10.063Z","4.2.0":"2020-02-10T09:11:45.084Z","4.2.1":"2020-05-02T10:44:46.655Z","4.2.2":"2020-05-02T11:09:16.986Z","4.3.1":"2020-05-02T22:38:43.277Z","4.4.0":"2020-12-24T10:36:28.192Z","4.4.1":"2020-12-29T10:07:25.205Z","4.4.2":"2021-08-25T14:29:32.926Z","4.5.0":"2023-05-16T08:53:44.009Z"},"homepage":"https://github.com/CICCIOSGAMINO/openweather-apis","keywords":["openweather","openweathermap","meteo","weather","weather-api","apis"],"repository":{"type":"git","url":"git+ssh://git@github.com/CICCIOSGAMINO/openweather-apis.git"},"author":{"name":"Marco Canali","email":"marco.canali@gmail.com","url":"https://github.com/CICCIOSGAMINO"},"bugs":{"url":"https://github.com/CICCIOSGAMINO/openweather-apis/issues"},"license":"MIT","readmeFilename":"README.md","users":{"cicciosgamino":true,"alexghinea":true,"rocket0191":true,"geeksunny":true}}