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

These services allow the retrieval of Properties. Note that unlike the RESO: Property service, these services do not return listings.

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
    2. Individual Property
    3. Nearby Properties
  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

/<API Version>/properties

HTTP Method Description Conditional Notes
GET Retrieves Properties data. 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:

GET Response

{
    "D": {
        "Results": [
            {
                "Id": 1204,
                "ResourceUri": "/v1/properties/1204",
                "StandardFields": {
                    "StreetNumber": "123",
                    "StreetDirPrefix": "",
                    "StreetName": "MAIN",
                    "StreetSuffix": "AVE",
                    "StreetDirSuffix": "",
                    "UnitNumber": "",
                    "City": "FARGO",
                    "StateOrProvince": "ND",
                    "PostalCode": "58103",
                    "PostalCodePlus4": "",
                    "Country": "US",
                    "CountyOrParish": "CASS",
                    "Municipality": "CASS",
                    "Township": "",
                    "SubdivisionName": "ORIGINAL TOWNSITE",
                    "ParcelNumber": "12-1234-1234-1234",
                    "YearBuilt": 1974,
                    "RoomsTotal": 23,
                    "BedroomsTotal": 6,
                    "BathroomsTotal": 8.0,
                    "BathroomsFull": 3,
                    "BathroomsHalf": 3,
                    "BathroomsThreeQuarter": 2,
                    "LivingArea": 1250,
                    "AttachedGarageYN": true,
                    "BuildingAreaTotal": 1750,
                    "Stories": 3,
                    "LotSizeAcres": 0.25,
                    "LotSizeSquareFeet": 10890,
                    "TaxYear": 2019,
                    "TaxAnnualAmount": 2750.0,
                    "TaxAssessedValue": 250000.0
                }
            }
        ],
        "Success": true
    }
}

Individual Property

/<API Version>/properties/<Property.Id>

HTTP Method Description Conditional Notes
GET Retrieve information for a single property. 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
Standard selection parameters No

GET Response

See the GET request section for for the Properties service.

Nearby Properties

/<API Version>/properties/nearby

Returns properties considered nearby to a point specified via the proximity parameters. Results are ordered by decreasing proximity to specified point.

HTTP Method Description Conditional Notes
GET Retrieve properties near a specified point. 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:

GET Response

See the GET request section for for the Properties service.

Properties Description

The fields present in the response for individual Properties will match those returned by the Properties Standard Fields service.

Expansions

None.