Listings: Clusters

Allows retrieval of clustered listings as bounded to a given location. A typical use case for this service is to retrieve clusters for a given location and map them. At that point, a user could drill down into a given cluster using a location search returning the listings that comprised the cluster.

Multiple RESO Dictionary Support
This service supports multiple RESO Data Dictionary versions.

Supported Roles
Available Services
1. Clustered Listings
Clustered Listings Description
Expansions

Supported Roles

Role	Reads	Writes
IDX	Yes	No
Public	Yes	No
VOW	Yes	No
Portal	Yes	No
Private	Yes	No

More information about roles may be found here.

Available Services

Clustered Listings

`/<API Version>/listings/clusters`
`/<API Version>/my/listings/clusters`
`/<API Version>/office/listings/clusters`
`/<API Version>/company/listings/clusters`
`/<API Version>/contacts/<Contact.Id>/listings/clusters`

HTTP Method	Description	Conditional	Notes
GET	Returns groups of clustered listings within the location supplied by the user.	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

Parameter	Required	Notes
_location	No	Required if a `_filter` parameter is not sent.
_clusters	No	The number of clusters to return. If passed, must be between 1 and 20. If not passed, the default is 10
_filter	No	The standard _filter search parameter. If passed, will restrict the criteria on the query. Required if a `_location` parameter is not passed.
_orderby	No	The standard _orderby parameter. If passed, will order the results of the Listings expansion.

GET Response

{
   "D":{
      "Results":[
         {
            "Clusters":[
               {
                  "Centroid":"point(46.8319865423434 -96.7871596059957)",
                  "Count": 16,
                  "Listings":[
                     {
                        "LastCachedTimestamp":"2014-08-12T13:00:14-05:00",
                        "Id":"20061009202539515319000000",
                        "StandardFields":{
                           "BathsTotal": 2,
                           "BedsTotal": 4,
                           "BuildingAreaTotal": 7275,
                           "City": "Fargo",
                           "CurrentPrice":151900.0,
                           "ListPrice":151900.0,
                           "PropertyType":"A",
                           "MlsId":"20000809145531659995000000",
                           "Latitude":46.843756,
                           "Longitude":-96.7959,
                           "ListingId":"06-5548",
                           "ListingKey":"20061009202539515319000000",
                           "MlsStatus":"Active",
                           "PostalCode": "58103",
                           "StandardStatus":"Active",
                           "StateOrProvince": "ND",
                           "UnparsedFirstLineAddress": "1234 Sesame Street North",
                           "Photos": [
                               {
                                   "ResourceUri": "/vX/listings/20061009202539515319000000/photos/20080917142739989238000000",
                                   "Id": "20080917142739989238000000",
                                   "Name": "Listing Photo",
                                   "Caption": "",
                                   "UriThumb": "http://photos.sparkplatform.com/demomls/20080917142739989238000000-t.jpg",
                                   "Uri300": "http://photos.sparkplatform.com/demomls/20080917142739989238000000.jpg",
                                   "Uri640": "http://resize.sparkplatform.com/demomls/640x480/true/20080917142739989238000000-o.jpg",
                                   "Uri800": "http://resize.sparkplatform.com/demomls/800x600/true/20080917142739989238000000-o.jpg",
                                   "Uri1024": "http://resize.sparkplatform.com/demomls/1024x768/true/20080917142739989238000000-o.jpg",
                                   "Uri1280": "http://resize.sparkplatform.com/demomls/1280x1024/true/20080917142739989238000000-o.jpg",
                                   "Uri1600": "http://resize.sparkplatform.com/demomls/1600x1200/true/20080917142739989238000000-o.jpg",
                                   "Uri2048": "http://resize.sparkplatform.com/demomls/2048x1600/true/20080917142739989238000000-o.jpg",
                                   "UriLarge": "http://photos.sparkplatform.com/demomls/20080917142739989238000000-o.jpg",
                                   "Primary": true
                               }
                           ]
                        },
                        "DisplayCompliance":{
                           "View":"Summary"
                        }
                     },
                     {
                        "LastCachedTimestamp":"2014-08-12T13:00:20-05:00",
                        "Id":"20060508144119016818000000",
                        "StandardFields":{
                           "BathsTotal": 1,
                           "BedsTotal": 3,
                           "BuildingAreaTotal": 4315,
                           "City": "Fargo",
                           "CurrentPrice":242500.0,
                           "ListPrice":242500.0,
                           "PropertyType":"A",
                           "MlsId":"20000809145531659995000000",
                           "Latitude":46.826043,
                           "Longitude":-96.776303,
                           "ListingId":"06-2418",
                           "ListingKey":"20060508144119016818000000",
                           "MlsStatus":"Active",
                           "PostalCode": "58103",
                           "StandardStatus":"Active",
                           "StateOrProvince": "ND",
                           "UnparsedFirstLineAddress": "101 142nd Ave East",
                           "Photos": []
                        },
                        "DisplayCompliance":{
                           "View":"Summary"
                        }
                     },
                     {
                        "LastCachedTimestamp":"2014-08-12T13:00:20-05:00",
                        "Id":"20060525210206822653000000",
                        "StandardFields":{
                           "BathsTotal": 1,
                           "BedsTotal": 3,
                           "BuildingAreaTotal": 4315,
                           "City": "Fargo",
                           "CurrentPrice":289900.0,
                           "ListPrice":289900.0,
                           "PropertyType":"A",
                           "MlsId":"20000809145531659995000000",
                           "Latitude":46.821593,
                           "Longitude":-96.783437,
                           "ListingId":"06-2868",
                           "ListingKey":"20060525210206822653000000",
                           "MlsStatus":"Active",
                           "PostalCode": "58103",
                           "StandardStatus":"Active",
                           "StateOrProvince": "ND",
                           "UnparsedFirstLineAddress": "2001 203rd St. North",
                           "Photos": []
                        },
                        "DisplayCompliance":{
                           "View":"Summary"
                        }
                     }
                  ],
                  "Location":"polygon('46.821593 -96.783437,46.830025 -96.7959,46.836694 -96.79736,46.839002 -96.797065,46.843756 -96.7959,46.833275 -96.777164,46.830291 -96.776531,46.826043 -96.776303,46.822268 -96.781212,46.821593 -96.783437')"
               },
               {
                  "Centroid":"point(46.8414086065949 -96.7662315696078)",
                  "Count": 37,
                  "Listings":null,
                  "Location":"polygon('46.827585 -96.77099,46.847903 -96.776355,46.853738 -96.774708,46.856319 -96.76785,46.85127 -96.762172,46.8413 -96.7567,46.8411 -96.7566,46.831886 -96.754296,46.827585 -96.77099')"
               },
               {
                  "Centroid":"point(46.8768758726594 -96.7627518987784)",
                  "Count": 42,
                  "Listings":null,
                  "Location":"polygon('46.859304 -96.75962,46.868561 -96.771511,46.870656 -96.773277,46.871756 -96.773767,46.888087 -96.771703,46.893616 -96.764722,46.889735 -96.759517,46.881374 -96.751157,46.87036 -96.752748,46.859304 -96.75962')"
               },
               {
                  "Centroid":"point(46.8612953398218 -96.7884794044262)",
                  "Count": 49,
                  "Listings":null,
                  "Location":"polygon('46.846344 -96.795022,46.863979 -96.79924,46.868507 -96.79915,46.872491 -96.796402,46.870512 -96.779783,46.867453 -96.777963,46.858435 -96.774848,46.846344 -96.795022')"
               },
               {
                  "Centroid":"point(46.8889925077561 -96.7864961160307)",
                  "Count": 58,
                  "Listings":null,
                  "Location":"polygon('46.875195 -96.784679,46.879341 -96.79627,46.889631 -96.799183,46.896039 -96.797001,46.898997 -96.794675,46.899973 -96.790667,46.899477 -96.777238,46.8975 -96.7724,46.88264 -96.777511,46.875798 -96.783114,46.875195 -96.784679')"
               }
            ],
            "Boundary":"polygon('46.899973 -96.79924,46.899973 -96.751157,46.821593 -96.751157,46.821593 -96.79924')"
         }
      ],
      "Success":true
   }
}

Clustered Listings Description

Attribute	Data Type	Description
`Boundary`	Character	A polygon shape outlining the rectangular boundary housing all clusters. Will be `null` if no clusters are present, or if there are not more than two unique points among the collection of clusters.
`Clusters`	Array of JSON Objects	The list of clusters.
`Clusters[n].Centroid`	Character	A point representing the center of the location value.
`Clusters[n].Count`	Integer	The number of listings held in this location.
`Clusters[n].Location`	Character	A shape describing the area the listings are located in.
`Clusters[n].Listings`	Expansion	A list of listings that fall into the cluster, along with primary photo for each. This will only be present if the `Listings` expansion was passed and the cluster count is 20 or less.

Expansions

Expansion	Roles	Single Record Only?	Selection Support?	Description
`Listings`	All	Yes	No	This expansion will provide listing details for clusters with a count of 20 or less.