This reference documents version 2.1 of the Placester RESTful API.

The code in this document requires an API key which you can obtain from the Placester plugin.

Basic Use

  http://api.placester.com/api/v2.1/listings/listing_id[.format]?api_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  

listing_id is the ID for the listing you want to retrieve. .format can be .xml or .json depending on the format you want the API to output.

cURL

curl -X GET -d "api_key=xxxxxxx" http://api.placester.com/api/v2.1/listings/515425a5bxxxx927180003c1

PHP

$listingid='515425a5bxxxx927180003c1';
$url = 'https://api.placester.com/api/v2.1/listings/' . $listingid;
$url .= '?api_key=' . $my_api_key_here;

$curlcall = curl_init();
curl_setopt($curlcall, CURLOPT_URL, $url);
$curlout = curl_exec($curlcall);

Arguments

ArgumentDescriptionExample

address_mode (Optional) When passed, forces the returned location rather than relying on the agency setting, can either be exact to use the true address or polygon to use Placester polygon addresses
listing_id (Required) The listing you want to retrieve

Returns

KeyDescription

id Listing ID
property_type What kind of listing this is
zoning_types[] How the listing is zoned
listing_types[] The types of the listing itself, different from the listing type
purchase_Types[] If the listing is for sale, rent, or both
cur_data Curated data attached to the listing
uncur_data Uncurated data attached to the listing
location Where the listing is located
location[address] Address, eg “1234 Fake Street”
location[locality] Locality, eg “Boston”
location[region] State, eg “MA”
location[postal] Postal Code, eg “02145”
location[neighborhood] Neighborhood, eg “Parkwood Heights”
location[country] 2-digit country code, eg “US”
location[coords][0] Latitude location of the address
location[coords][1] Longitude location of the address
contact[] How potential leads can contact the agent
contact[email] Placester tracking email, will be forwarded to the agencies email address
contact[phone] The agencies phone number
tracker_url Tracking URL to reference the listing, must be used for Placester to provide traffic data on the listing
rel_people People related to this listing
rets RETS information when available for the listing

Sample Output

    <listing>
      <id>51a8f157960df91c06000001</id>
      <cur-data>
        <baths>1</baths>
        <beds>2</beds>
        <cble-rdy>true</cble-rdy>
        <desc>
          LIVES LARGER THAN LISTING READS. CHARMING &amp; BEAUTIFULLY RENOVATED HOME. HIGH CEILINGS, SPACIOUS SUN-FILLED ROOMS &amp; HARDWOOD FLOORS. BASEMENT PLAYROOM 16X12 (NOT INCLUDED IN SQUARE FOOTAGE). MATURE PLANTINGS &amp; AN OPEN, MANICURED LAWN ROUND OUT THIS LOVELY DARIEN HOME! ONE MONTHS RENT &amp; TWO MONTHS SECURITY DEPOSIT DUE AT SIGNING OF LEASE. TENANT RESPONSIBLE FOR CREDIT CHECK, UTILITIES &amp; LAWN MAINTENANCE. AVAILABLE AUGUST 1, 2013.
        </desc>
        <half-baths>0</half-baths>
        <price>3500.0</price>
        <sqft>1345.0</sqft>
        <style>English Cottage</style>
        <year-blt>1929</year-blt>
        <url>
          http://pinkponyhats.us/?property=51a8f157960df91c06000001
        </url>
      </cur-data>
      <uncur-data>
        <additional-rooms>Playroom</additional-rooms>
        <appliances-included>
          Cook Top, Dishwasher, Disposal, Dryer, Refrigerator, Washer
        </appliances-included>
        <attic-description>Pulldown Stairs</attic-description>
        <elementary-school>Holmes</elementary-school>
        <exterior-features>Fence, Garden Area, Gas Grill, Outbuilding</exterior-features>
        <exterior-siding>Vinyl Siding</exterior-siding>
        <fireplaces>1</fireplaces>
        <flooring>Wood, Tile, Carpeted</flooring>
        <fuel-type>Natural Gas</fuel-type>
        <heat-type>Radiator, Baseboard</heat-type>
        <interior-features>Wainscoting,Whirlpool</interior-features>
        <middle-school>MIDDLESX</middle-school>
        <senior-high-school>Darien</senior-high-school>
        <sewage>Public Sewer Connected</sewage>
        <water-source>Public Water Connected</water-source>
        <year-renovated>1998</year-renovated>
      </uncur-data>
      <agency-id>505b64830941636a2d000020</agency-id>
      <provider-id>505b4453d23a543cd80002bc</provider-id>
      <import-id>505b647cd23a543d3500033f</import-id>
      <zoning-types>
        <zoning-type>residential</zoning-type>
      </zoning-types>
      <purchase-types>
        <purchase-type>rental</purchase-type>
      </purchase-types>
      <listing-types/>
      <compound-type>res_rental</compound-type>
      <building-id>51a8f159960df91c06000003</building-id>
      <rets>
        <aid>LAWTONC</aid>
        <oid>KLLY01</oid>
        <mls-id>18228</mls-id>
        <oname>Kelly Associates Real Estate</oname>
        <aname>Lawton Cathy</aname>
      </rets>
      <location>
        <neighborhood nil="true"/>
        <locality>Darien</locality>
        <region>CT</region>
        <postal>06820</postal>
        <unit nil="true"/>
        <country>US</country>
        <county>Fairfield</county>
        <address>68 Middlesex Road</address>
        <coords>
          <coord>41.077227</coord>
          <coord>-73.50827179999999</coord>
        </coords>
      </location>
      <contact>
        <email>
          inq-10oa5boya3tn1epvi001-105z0q06qp18raw29010@placester.net
        </email>
      </contact>
      <tracker-url>
      https://placester.com/listing/lead/505b64830941636a2d000020/51a8f157960df91c06000001
      </tracker-url>
      <images>
        <image>
        <id>51a8f1ec960df91c0600001b</id>
        <url>
        http://d126fxm3orgy3k.cloudfront.net/images/51a8f157960df91c06000001/51a8f1ec960df91c0600001b.jpeg?pid=505b64830941636a2d000020&kid=4f9eeff4d23a544121000257
        </url>
        <order>1</order>
        </image>
      </images>
    </listing>