Code Monkey home page Code Monkey logo

grubhub-scraper's Introduction

Grubhub-API

The api you wish grubhub had...

Install

Install with npm:

npm install grubhub-api

Example

var Search = require('grubhub-api').Search;

var search = new Search('1234 Blueberry Hill, Ny');

search.run({perPage: 15, page: 1}, function(err, results) {
  results.forEach(function(restaurant) {
    console.log(
      "Restaurant %s is %d miles away, has a rating of %d",
      restaurant.name, restaurant.distance, restaurant.grubhubRating
    );
  });
});

Example Search Response

A search will include restauraunt objects in an array. The object is as follows:

{ name: 'Smith Express Food ',
  grubhubRating: 3.43,
  yelpRating: 1.5391592,
  distance: 0.917472394592236,
  cuisines:[ 
    'sandwiches',
    'american',
    'breakfast',
    'wraps',
    'bagels',
    'hamburgers',
    'dinner'
   ]
}

Sort Options

  • onlyOpen: include only currently open restaurants

  • sort: How to sort, valid options are

    • STAR_RATING - sort by ratings
    • ORDER_MINIMUM - sort by min-price
    • DISTANCE - can you guess?
  • cuisine: include the cusines you want, currently not supported, but planned

Configuring a Search

location(String)

Sets the location

var Search = new Search();
Search.location('1234 Blueberry Hill');

onlyOpen(Boolean)

Sets whether to only search for open locations. true by default.

var Search = new Search();
Search.onlyOpen(true);

autolocate(Boolean)

Sets whether or not to auto-select when a location search returns multiple results. Defaults to true. If false, search will throw an error if location returns multiple results.

var Search = new Search();
Search.autolocate(false);

grubhub-scraper's People

Contributors

rschmukler avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

grubhub-scraper's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.