Punchfork.com API for node.js
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
Readme.md
package.json

Readme.md

node-punchfork

Node.js library to access Punchfork's API.

Quick start

npm install punchfork

Example Usage

// your-app-name is used as the request's User-Agent header
var punchfork = require('punchfork')('your-api-key', 'your-app-name');

// search for all recipes with lettuce
punchfork.recipeSearch({
  q: 'lettuce'
}, function(err, recipes) {
  if (err) return console.log(err);
  console.log('recipes:', recipes);
  return;
});

API

All methods take a callback as their last parameter.

The callback is called with an error code if needed, and then the repsonse.

  • punchfork.recipeSearch(options) - same as what you'd type into search box at http://punchfork.com
  • punchfork.randomRecipe - a recipe selected at random from database
  • punchfork.listOfPublishers - lists all recipe publishers on Punchfork
  • punchfork.generateSearchIndex(options) (Ultra API only) - list of generated search index terms for the input recipe
  • punchfork.rateLimitStatus - the number of remaining API calls allowed today for the given API key

More information on the API is available at http://punchfork.com/api.

Tests

To run tests, install vows:

npm install vows

Then run:

PUNCHFORK_API=your-api vows test/*

Contributors

License

MIT Licensed