kickstarter API wrapper for node
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
examples
lib
.gitignore
.groc.json
.npmignore
BUGS.md
LICENSE
README.md
TODO.md
index.js
package.json

README.md

node-kicks

kickstarter API for node

Introduction

Since the public introduction of the Kickstarter mobile app1, a semi-public web service API has been available.2, 3 This API is internal, and is subject to change, but still provides a more reliable method than scraping.4

kicks provides a fluent wrapper around this API. Since the API is still in flux, methods are provided to introspect the API and call remote procedures which may be added. Convenience methods are provided explicitly wrapping known remote procedure signatures.

Quick Start

var kicks = require('kicks');
var config = require('./config');

kicks.Client.fromEmail(config.email, config.password, null, function (err, client) {
    if (err) console.error(err);
    else client.search_projects('coffee', 50, function (err, projects) {
        if (err) console.error(err);
        else console.log(projects.map(function (project) {
            return {
                name: project.name,
                blurb: project.blurb,
                location: project.location.name,
                url: project.urls.web.project_short
            };
        }));
    });
});

(This code is available in examples/readme-example.js.)

API Reference

Currently, the only API reference is the groc docs, so you'll have to open the ./doc/index.html in your browser to get at them.

References

  1. Kickstarter iOS App
  2. Let's explore Kickstarter's API, Mark Olson.
  3. kickscraper ruby gem
  4. kickstarter scraper on NPM