Skip to content

Latest commit

 

History

History
59 lines (49 loc) · 1.38 KB

README.md

File metadata and controls

59 lines (49 loc) · 1.38 KB
Raw

Clara

=========================

A Simple Package for getting home worth using the Zillow API and displaying the Property Image by Using Google Map. Clara can help speed up the creation of a real estate website or a section for showing home value on your website.

Requirements

Zillow Property Listing API KEY Google Map Javascript API KEY

Features

  • PSR-4 autoloading compliant structure
  • Unit-Testing with PHPUnit
  • Examples
  • Easy to use to any framework or even a plain php file
  • Search and Deep Search Result API from Zillow

Instalation

$ composer require godwin-ojebiyi/clara

Usage

require_once(__DIR__ . '/vendor/autoload.php');
use GodwinOjebiyi\Clara;
$clara = new Clara($zillow_id, $google_maps_api_key);

Set Address for clara to work on

$clara->set_address("address");

Get Address clara is working on

$clara->get_address();

Get Home Worth

if($clara->get_home_worth()){
	echo $clara->show_estimate_info('home_url');
	echo $clara->show_estimate_info('zestimate_low');
	echo $clara->show_estimate_info('zestimate_high');
	echo $clara->show_estimate_info('zestimate');
}else{
	echo "Clara cannot find your home with Zillow";
}

Get Property Image

echo $clara->get_property_image($width, $height);

Coming Soon

  • Estimated Property Value Growth Chart
  • Ability to include bootstrap classes in Clara.