Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Privileged API Keys Only

Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.

Properties: Clusters

These services allow the retrieval of clustered Properties within specific boundaries.

 

Alpha Only: This service is subject to change

This service is a work in progress. It is currently subject to change or removal without notice.

  1. Supported Roles
  2. Available Services
    1. Properties Clusters
  3. Response Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
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

Properties Clusters

/<API Version>/properties/clusters

HTTP Method Description Conditional Notes
GET Retrieves clusters of properties. 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, results will be filtered accordingly. Required if a _location parameter is not passed.
_orderby No The standard _orderby parameter. If passed, will order the results of the Properties expansion.
Standard selection parameters No Applies to the results contained in the Properties expansion.
 
 

GET Response

{
    "D": {
        "Results": [
            {
                "Clusters": [
                    {
                        "Location": "point(29.9574 -90.0629)",
                        "Centroid": "point(29.9574 -90.0629)",
                        "Count": 1
                    },
                    {
                        "Location": "linestring('46.873801 -96.767801,46.874321 -96.789012')",
                        "Centroid": "point(46.874061 -96.7784065)",
                        "Count": 2
                    }
                ],
                "Boundary": "polygon('46.874321 -96.789012,46.874321 -90.0629,29.9574 -90.0629,29.9574 -96.789012')"
            }
        ],
        "Success": true
    }
}
 
 

Clustered Properties 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.
Centroid Character A point representing the center of the location value.
Count Integer The number of Properties held in this location.
Location Character A shape describing the area the Properties are located in.
Properties Expansion A list of Properties contained by the cluster. This will only be present if the Properties expansion was requested and the cluster contains 20 or fewer Properties.
 

Expansions

Expansion Roles Single Record Only? Selection Support? Description
Properties Private No No Include details for all Properties in clusters containing fewer than 20 results.