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.
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. |