Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A ruby implementation of the YellowPage's YellowAPI
branch: master

This branch is 1 commit behind ianbishop:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
.autotest
.gitignore
Gemfile
LICENSE.md
README.md
Rakefile
yellow_api.gemspec

README.md

Yellow API

Ruby wrapper for the YellowPages' YellowAPI.

Installation

gem install yellow_api

Examples

require 'yellow_api'

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

@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

# 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 stolen/inspired by hacker_news_search and twitter.

Copyright

See LICENSE for more details.

Something went wrong with that request. Please try again.