clearweatherapi

Clear Weather API

Clear Weather API transforms OpenWeather Map OneCall data into human-readable code so you can get to building apps faster.

I built this library to make it easier to use the ClearWeather API.

Learn more about Clear Weather API.

Features

• Data Transformation (Premium)
• Avoid hitting rate limits with Caching (Premium)
• Cool Weather Icons (Premium)
• Limit errors with types for all weather data
• This package will make it smooth and easy to develop

Getting Started

You need an OpenWeather Map API key to use this library, and you can get one by signing up at Open Weather Map.

You can get more information about the One Call API at Open Weather Map Onecall.

Installation

npm

npm install clearweatherapi

yarn

yarn add clearweatherapi

Usage

---

Instantiate Weather class and pass options to it.

const options = {
  openWeatherApiKey: 'YOUR_OPENWEATHER_API_KEY',
  userId: 'YOUR-CLEATHERWEATHERAPI-USERID',
  coords: {
    latitude: '',
    longitude: '',
  },
  cacheTime: 4800,
  formated: false,
  lang: 'en',
  units: 'imperial',
  version: '3.0',
};

const weather = new Weather(options);

---

To get more information about what each method returns refer to the docs.

Current weather

const current = await weather.fetchCurrentWeather();

Daily weather

const daily = await weather.fetchDailyWeather();

Hourly weather

const hourly = await weather.fetchHourly();

Onecall weather

const onecall = await weather.fetchOneCall();

Weather alerts

const alerts = await weather.fetchAlerts();

Icons

Icons are available for premium users and can be found in each weather data object.

If you are not a premium user you can get more information on how to fetch the icons here.

options

Name	Type	Required	Description
openWeatherApiKey	string	true	Your OpenWeatherMap API key. You can get a free API key here.
userId	string	true	Your Clear Weather API user ID Sign up at Clear Weather API to get you free user id.
coords	object	true	The coordinates to get weather data for. This is an object with latitude and longitude properties.
cacheTime	number	false	The time in seconds to cache data for. Maximum time is 43200 (12 hours) at a time (Premium)
formated	boolean	false	Whether or not to format the data (Premium)
units	string	false	The units to use for the data. Default is imperial. Options are metric, imperial, and standard
version	string	false	The version of the API to use. Default is 3.0. Options are 2.5 and 3.0