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.

Supported Roles
Available Services
1. All Registered Listings
2. Individual Registered Listing
All Registered Listings Description
Expansions

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:

None

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.