@ymchandra/weather_api
v1.0.1
Published
_IntroductionWeatherAPI_com_provides_access_to_weather_and_geo_data_via_a_JSONXML_restful_API__It_allows_developers_to_create_desktop_web_and_mobile_applications_using_this_data_very_easy___We_provide_following_data_through_our_API______Real_time_weather_
Downloads
5
Readme
Javascript client for WeatherAPI.com
Introduction
WeatherAPI.com provides access to weather and geo data via a JSON/XML restful API. It allows developers to create desktop, web and mobile applications using this data very easy.
We provide following data through our API:
- Real-time weather
- 14 day weather forecast
- Astronomy
- Time zone
- Location data
- Search or Autocomplete API
- NEW: Historical weather
- NEW: Future Weather (Upto 300 days ahead)
- Weather Alerts
- Air Quality Data
Getting Started
You need to signup and then you can find your API key under your account, and start using API right away!
We have code libraries for different programming languages like PHP, .net, JAVA, etc. If you find any features missing or have any suggestions, please contact us.
Authentication
API access to the data is protected by an API key. If at anytime, you find the API key has become vulnerable, please regenerate the key using Regenerate button next to the API key. Authentication to the WeatherAPI.com API is provided by passing your API key as request parameter through an API .
key parameter
key=YOUR_API_KEY
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install weather_api --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your weather_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('weather_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/weather_api then install it via:
npm install YOUR_USERNAME/weather_api --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var WeatherApi = require('weather_api');
var defaultClient = WeatherApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['key'] = "Token"
var api = new WeatherApi.APIsApi()
var q = "q_example"; // {String} Pass US Zipcode, UK Postcode, Canada Postalcode, IP address, Latitude/Longitude (decimal degree) or city name. Visit [request parameter section](https://www.weatherapi.com/docs/#intro-request) to learn more.
var dt = new Date("2013-10-20"); // {Date} Date on or after 1st Jan, 2015 in yyyy-MM-dd format
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.astronomy(q, dt, callback);
Documentation for API Endpoints
All URIs are relative to https://api.weatherapi.com/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- WeatherApi.APIsApi | astronomy | GET /astronomy.json | Astronomy API WeatherApi.APIsApi | forecastWeather | GET /forecast.json | Forecast API WeatherApi.APIsApi | futureWeather | GET /future.json | Future API WeatherApi.APIsApi | historyWeather | GET /history.json | History API WeatherApi.APIsApi | ipLookup | GET /ip.json | IP Lookup API WeatherApi.APIsApi | realtimeWeather | GET /current.json | Realtime API WeatherApi.APIsApi | searchAutocompleteWeather | GET /search.json | Search/Autocomplete API WeatherApi.APIsApi | timeZone | GET /timezone.json | Time Zone API
Documentation for Models
- WeatherApi.Alerts
- WeatherApi.ArrayOfSearch
- WeatherApi.Astronomy
- WeatherApi.Current
- WeatherApi.Error400
- WeatherApi.Error401
- WeatherApi.Error403
- WeatherApi.Forecast
- WeatherApi.Ip
- WeatherApi.Location
- WeatherApi.Search
Documentation for Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: key
- Location: URL query string