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.

Registered Listings

Registered listings are managed but unmarketed listings for an agent. Once entered into the system, these entries are exclusive to the office, and have strict rules for further modification after creation.

 
  1. Supported Roles
  2. Available Services
    1. All Registered Listings
    2. Individual Registered Listing
  3. All Registered Listings Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW No No
Portal No No
Private Yes Yes Privileged roles only for writes.

More information about roles may be found here.

 

Available Services

All Registered Listings

/<API Version>/listings/registered

HTTP Method Description Conditional Notes
GET Returns an abridged set of StandardFields for all registered listing records viewable by the current user. No The fields in this view include the following:
  • UnparsedAddress
  • UnparsedFirstLineAddress
  • ListingKey
  • ListAgentId
  • ListPrice
  • ListAgent* fields
  • MlsId
  • ExpirationDate
  • OnMarketTimestamp
POST Creates a new registered listing record. No
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 search and paging syntax No
 
 

GET Response

{
    "D": {
        "Success": true,
        "Results": [{
            "ResourceUri": "/vX/listings/registered/20200615154144530217000000",
            "Id": "20200615154144530217000000",
            "StandardFields": {
                "UnparsedAddress": "1234 Registered Lane S, Fargo, ND 58103",
                "UnparsedFirstLineAddress": "1234 Registered Lane S",
                "ListingKey": "20200615154144530217000000",
                "ListPrice": 300000,
                "ListAgentId": "20080917142739989238000000",
                "ListAgentFirstName": "Joe",
                "ListAgentMiddleName": "J.",
                "ListAgentLastName": "Agent",
                "ListAgentPreferredPhone": "123-456-7890",
                "ListAgentPreferredPhoneExt": "3",
                "ListAgentOfficePhone": "123-456-7890",
                "ListAgentOfficePhoneExt": "123-456-7890",
                "ListAgentCellPhone": "123-456-7890",
                "ListAgentDirectPhone": "123-456-7890",
                "ListAgentTollFreePhone": "123-456-7890",
                "ListAgentFax": "123-456-7890",
                "ListAgentPager": "123-456-7890",
                "ListAgentVoiceMail": "123-456-7890",
                "ListAgentVoiceMailExt": "123-456-7890",
                "ListAgentEmail": "joe@joeagent.com",
                "ListAgentURL": "http://joeagent.com/",
                "ListAgentStateLicense": "12345",
                "ListAgentDesignation": "CRS, GRI",
                "ListOfficeName": "BigBrokerCo",
                "ListOfficePhone": "987-654-3210",
                "ListOfficePhoneExt": "33",
                "ListOfficeFax": "987-654-3210",
                "ListOfficeEmail": "big@brokerco.com",
                "ListOfficeURL": "http://bigbrokerco.com",
                "MlsId": "20000426143505724628000000",
                "ExpirationDate": "2020-09-15",
                "OnMarketTimestamp": "2020-06-15T00:00:00Z"
            }
        }]
    }
}
 

POST Request

Request body:

{
   "D":{
        "PropertyType": "A",
        "ListPrice": 300000,
        "StreetNumber": "1234",
        "StreetName": "Registered",
        "StreetSuffix": "Ln",
        "StreetDirSuffix": "S",
        "City": "Fargo",
        "StateOrProvince": "ND",
        "PostalCode": "58103",
        "ParcelNumber": "Reg1234",
        "ListAgentId": "20080917142739989238000000",
        "ExpirationDate": "2020-09-15",
        "ListingContractDate": "2020-06-01",
        "OnMarketTimestamp": "2020-06-15T00:00:00Z"
   }
}
 

POST Response

The standard success/fail response with additional error information is returned.

 
 

Individual Registered Listing

/<API Version>/listings/registered/<Listing.Id>

HTTP Method Description Conditional Notes
GET Returns full StandardFields data for the registered listing with the specified Id 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 Listings service.

 

Registered Listing Description

Attribute Data Type Searchable Description
StreetAddress Character Yes (Searching only) Registered listings can be filtered by StreetAddress.
Id Character Yes The unique id for the record.
StandardFields JSON Object No Registered listings only return a subset of the standard field listing data.
ListingKey Character Yes Mirrors Listing.Id.
UnparsedFirstLineAddress Character No The first line of the street address for the listing.
UnparsedAddress Character No The street address for the listing.
ListPrice Decimal No The listing price.
ListAgentId Character Yes The Id of the listing agent.
ListOfficeId Character Yes The Id of the listing office.
ListAgent* Varies No All listing agent profile data present in a normal listings response is also present in the registered listing response. See the Standard Fields service for more details.
MlsId Character No The Id of the MLS the listing belongs to.
StreetNumber Character No The street number address component for the listing.
StreetDirPrefix Character No A direction indicator preceeding the street name for the listing address.
StreetName Character No The street name address component for the listing.
StreetSuffix Character No The street suffix address component for the listing.
StreetDirSuffix Character No A direction indicator after the street name for the listing address.
StreetSuffixModifier Character No Another street suffix address component for the listing.
UnitNumber Character No The unit number address component for the listing.
City Character No The city in the listing address.
CountyOrParish Character No The county or parish portion of the listing address.
StateOrProvince Character No Field containing the accepted postal abbreviation for the state or province.
PostalCode Character No The postal code portion of a street or mailing address.
PostalCodePlus4 Character No The postal code +4 portion of a street or mailing address.
ParcelNumber Character No A unique identifier for the parcel typically issued by the county or county assessor.
ListingContractDate Date Yes The entry date for this listing.
ExpirationDate Date Yes The contract expiration date with this listing.
OnMarketTimestamp DateTime Yes Anticipated time this listing will be entered as an active and marketable listing.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.