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 Origins 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
FloPlan
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

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.