openweather-api-node

Simple package that makes it easy to work with OpenWeather API.

About

This package is a wrapper for OpenWeather API. If you want to learn how to use this package check out examples in examples directory. The only thing that you need to get started is API key if you don't have one go to OpenWeatherMap website and get it. For now this package supports only a part of the API but we are planning on adding more features like: triggers, maps and all the other stuff that is available for free in OpenWeatherMap API.

Currently Supported APIs:

• Current Weather - get current weather
• Forecast - get weather forecast for up to 5 days with 3-hour step
• OneCall - get current weather and weather forecast for up to 7 days
• Geocoding - get location latitude and longitude from its name and vice versa
• Historical - get weather from previous 5 days
• Air pollution - get current, forecasted and historical data about air pollution

Installation

npm i openweather-api-node

Examples

JS:

const { OpenWeatherAPI } = require("openweather-api-node")

let weather = new OpenWeatherAPI({
    key: "put-key-here",
    locationName: "New York",
    units: "imperial"
})

/* 
you can use setters as well:
weather.setKey("put-key-here")
weather.setLocationByName("New York")
...
*/

weather.getCurrent().then(data => {
    console.log(`Current temperature in New York is: ${data.weather.temp.cur}\u00B0F`)
})

TS:

import OpenWeatherAPI from "openweather-api-node"

let weather = new OpenWeatherAPI({
    key: "put-key-here",
    locationName: "New York",
    units: "imperial"
})

/* 
you can use setters as well:
weather.setKey("put-key-here")
weather.setLocationByName("New York")
...
*/

weather.getCurrent().then(data => {
    console.log(`Current temperature in New York is: ${data.weather.temp.cur}\u00B0F`)
})

Documentation for v2

Documentation for older versions

---

Old OneCall api endpoint

⚠️This package uses the OneCall v2 api endpoint and some of the methods like getMinutelyForecast or getAlerts will not work with API keys created after the introduction of OneCall v3 api. Support for version 3 is is planned to be a part of openweather-api-node@3.0.0