Simple ruby interface for the Zillow API.
Documentation & Requirements
Supported API Calls
As of version 0.1.0, we support the following API calls:
To make these calls, you call the module method
Zillow4r.fetch_[name] where name is the underscored
api call name without the "Get". For example, if you wanted to call the GetDeepSearchResults
Zillow4r.fetch_deep_search_results with the search parameters specified by the API.
Note: Zillow4r will automatically add your ZWSID to the API request.
require 'rubygems' require 'zillow4r' Zillow4r.zws_id = 'YOUR_API_KEY' response = Zillow4r.fetch_updated_property_details(:zpid => 123456) response.class => Zillow4r::Api::UpdatedPropertyDetails response = Zillow4r.fetch_search_results(:address => "2114 Bigelow Ave", :citystatezip => "Seattle, WA") response.class => Zillow4r::Api::SearchResults response.results.class => Array response.results.first.class => Zillow4r::Property
Zillow4r uses several intermediate data models which represent repeated data structures contained within Zillow's xml. These include:
These models define the data that they contain through their position within the xml data.
Test cases are mocked using the sample API output provided for each API call in the documentation from Zillow.