Mashape Weather API

Browser and node module for making API requests against Mashape Weather API.

Please note: This module uses Popsicle to make API requests. Promises must be supported or polyfilled on all target environments.

Installation

npm install mashape-weather-api --save
bower install mashape-weather-api --save

Usage

Node

var MashapeWeatherApi = require('mashape-weather-api');

var client = new MashapeWeatherApi();

Browsers

<script src="mashape-weather-api/index.js"></script>

<script>
  var client = new MashapeWeatherApi();
</script>

Options

You can set options when you initialize a client or at any time with the options property. You may also override options for a single request by passing an object as the second argument of any request method. For example:

var client = new MashapeWeatherApi({ ... });

client.options = { ... };

client.resource('/').get(null, {
  baseUri: 'http://example.com',
  headers: {
    'Content-Type': 'application/json'
  }
});

Base URI

You can override the base URI by setting the baseUri property, or initializing a client with a base URI. For example:

new MashapeWeatherApi({
  baseUri: 'https://example.com'
});

Base URI Parameters

If the base URI has parameters inline, you can set them by updating the baseUriParameters property. For example:

client.options.baseUriParameters.version = 'v1';

Resources

All methods return a HTTP request instance of Popsicle, which allows the use of promises (and streaming in node).

resources.aqi

var resource = client.resources.aqi;

GET

Get the air quality index (AQI). The AQI number indicates the level of pollution in the air. Higher numbers are worse.

resource.get().then(function (res) { ... });

Query Parameters

resource.get({ ... });

• Latitude number

The latitude coordinate

• lng number

The longitude coordinate

Headers

resource.get(null, {
  headers: { ... }
});

• Mashape key string

This header is used to send data that contains your mashape API key

resources.weather

var resource = client.resources.weather;

GET

Gets the weather forecast for the current day

resource.get().then(function (res) { ... });

Query Parameters

resource.get({ ... });

• Latitude number

The latitude coordinate

• lng number

The longitude coordinate

Headers

resource.get(null, {
  headers: { ... }
});

• Mashape key string

This header is used to send data that contains your mashape API key

resources.weatherdata

var resource = client.resources.weatherdata;

GET

Gets a detailed weather object containing a lot of different weather information in a JSON object.

resource.get().then(function (res) { ... });

Query Parameters

resource.get({ ... });

• Latitude number

The latitude coordinate

• lng number

The longitude coordinate

Headers

resource.get(null, {
  headers: { ... }
});

• Mashape key string

This header is used to send data that contains your mashape API key

Custom Resources

You can make requests to a custom path in the API using the #resource(path) method.

client.resource('/example/path').get();

License

Apache 2.0