songkick-wrapper

1.2.1 • Public • Published

songkick-wrapper Build Status

A node.js wrapper around songkick's API.

Installation

Install using npm:

    npm install songkick-wrapper

Or clone the GitHub repo:

    git clone https://github.com/suhdev/songkick-wrapper.git

Usage

After installing/cloning the module, you can open a node console:

    node

and import the module:

    var Songkick = require("songkick-wrapper");

If GitHub repo was used then:

    var Songkick = require("PATH TO YOUR INSTALLATION");

Create an instance of SongKick using the factory method passing your API key:

    var songKick = SongKick.create("<YOUR API KEY>");
 
    songkick.getEventDetails("EVENT_ID","DATA_TYPE");
 

The returned results

SongKick responses have the following structure:

    {
        "resultsPage":{
            "results":{
 
            }
        }
    }

The module returns the 'resultsPage' skipping the outer wrapper object for convenience. See below:

    {
        "results":{
 
        }
    }

For more details documentation, have a look at the API's reference

You can request an API key at songkick's website.

Feel free to add/change/use the module in anyway you want. :D

Copyright

Copyright (c) 2015 Suhail Abood

Readme

Keywords

Package Sidebar

Install

npm i songkick-wrapper

Weekly Downloads

1

Version

1.2.1

License

ISC

Last publish

Collaborators

  • suhail