README.md

Yellow API

Ruby wrapper for the YellowPages' YellowAPI.

Installation

$ gem install yellow_api

Usage

Creating a client

# Production
@client = YellowApi.new(:apikey => "yourapikeygoeshere")

# Sandbox
@client = YellowApi.new(:apikey => "sandboxapikey", :sandbox_enabled => true)

Find businesses by listing

@client.find_business("barber", "Ottawa")

@client.find_business("barber", "Ottawa", { :pgLen => 10 }) # Limit to 10 listings

Get business details

my_barber = @client.find_business("barber", "Ottawa").listings.first
@client.get_business_details(my_barber.address.prov, my_barber.name, my_barber.id)

Find dealers

@client.find_dealer(6418182, { :pgLen => 10 })

Get type ahead

@client.get_type_ahead("auto", :what)
@client.get_type_ahead("monct", :where)

Documentation

See here

Official API docs

Inspiration

API style was largely inspired by sferik's twitter.

Copyright

See LICENSE for more details.