This reference documents version 2 of the Placester RESTful API.

The code in this document requires an API key which you can obtain from the Placester plugin. Each call to the API returns a maximum of 50 listings. If you need more listings, refer to the offset argument below.

Basic Use[agency_id][.format]?api_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx


curl -X GET -d "api_key=xxxxxxxxxxxxxx"


$url = '' . $my_api_key_here;

$curlcall = curl_init();
curl_setopt($curlcall, CURLOPT_URL, $url);
curl_setopt($curlcall, CURLOPT_HTTPGET, 1);

$curlout = curl_exec($curlcall);

[.format] can be .xml or .json depending on the format you want the API to output.


Arguments are specified on the URL usually after the API key and are separated by an &. You can use the following patterns for different types of arguments:

Format URL Argument
String, Integer, or Float key=StringValue
Array key[]=StringValue1&key[]=StringValue2&key[]=StringValue3…
Hash metadata[key]=2&metadata[key]=4


Argument Description Example
agency_id Agency ID to filter by (Optional)
include_disabled=Boolean Whether to include disabled listings in the results



Key Description
postal[] Array of all the postal/zip codes
region[] Array of all the regions/states
locality[] Array of all the cities
neighborhood[] Array of all the neighborhoods
county[] Array of all the counties


Sample Output

<?xml version="1.0" encoding="UTF-8"?>
        <locality>South Bend</locality>
        <neighborhood>Fair Oak</neighborhood>
        <neighborhood>Abbott Acre</neighborhood>
        <neighborhood>Forest Park Heights</neighborhood>
        <county>St. Joseph</county>