Open Houses

The Open Houses service returns information about all upcoming open house events in the current user's MLS. For open houses associated with specific listings and open houses metadata, see the Listings: Open Houses service.

Supported Roles
Available Services
Open Houses Description
Expansions

Supported Roles

Role	Reads	Writes	Notes
IDX	Yes	No
Public	Yes	No
VOW	Yes	No
Portal	Yes	No
Private	Yes	No	See Listings: Open Houses for writes

More information about roles may be found here.

Available Services

All Upcoming Open Houses

`/<API Version>/openhouses`

HTTP Method	Description	Conditional	Notes
GET	Returns all upcoming open houses	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 search and paging syntax	No

GET Response

{
    "D": {
        "Results": [
            {
                "Id": "20200121001306617362000000",
                "ResourceUri": "/v1/listings/20130718132609985967000000/openhouses/20200121001306617362000000",
                "ListingKey": "20130718132609985967000000",
                "ModificationTimestamp": "2020-01-21T00:13:06Z",
                "Date": "02/09/2020",
                "StartTime": "10:00 am",
                "EndTime": "6:00 pm",
                "OpenHouseStartTimestamp": "2020-09-02T15:00:00Z",
                "OpenHouseEndTimestamp": "2020-09-02T23:00:00Z",
                "Comments": "hunter",
                "AdditionalInfo": [
                    {
                        "Hosted By:": "Agent Hunter"
                    },
                    {
                        "Hosted Phone": ""
                    },
                    {
                        "Area": ""
                    }
                ]
            },
            {
                "Id": "20200204155316608872000000",
                "ResourceUri": "/v1/listings/20130718132609985967000000/openhouses/20200204155316608872000000",
                "ListingKey": "20130718132609985967000000",
                "ModificationTimestamp": "2020-02-04T15:53:16Z",
                "Date": "03/01/2020",
                "StartTime": "9:00 am",
                "EndTime": "12:00 pm",
                "OpenHouseStartTimestamp": "2020-01-03T15:00:00Z",
                "OpenHouseEndTimestamp": "2020-01-03T18:00:00Z",
                "Comments": "Free pretzels!",
                "AdditionalInfo": [
                    {
                        "Hosted By:": null
                    },
                    {
                        "Hosted Phone": null
                    },
                    {
                        "Area": null
                    }
                ]
            }
        ],
        "Success": true
    }
}

Individual Open House Event

`/<API Version>/openhouses/<OpenHouse.Id>`

HTTP Method	Description	Conditional	Notes
GET	Returns a specified open house record	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

{
    "D": {
        "Results": [
            {
                "Id": "20200121001306617362000000",
                "ResourceUri": "/v1/listings/20130718132609985967000000/openhouses/20200121001306617362000000",
                "ListingKey": "20130718132609985967000000",
                "ModificationTimestamp": "2020-01-21T00:13:06Z",
                "Date": "02/09/2020",
                "StartTime": "10:00 am",
                "EndTime": "6:00 pm",
                "OpenHouseStartTimestamp": "2020-09-02T15:00:00Z",
                "OpenHouseEndTimestamp": "2020-09-02T23:00:00Z",
                "Comments": "hunter",
                "AdditionalInfo": [
                    {
                        "Hosted By:": "Agent Hunter"
                    },
                    {
                        "Hosted Phone": ""
                    },
                    {
                        "Area": ""
                    }
                ]
            }
        ],
        "Success": true
    }
}

Open House Validation

`/<API Version>/openhouses/validation`

HTTP Method	Description	Conditional	Notes
GET	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
POST	Validates open house data to be created, but does not perform the actual creation.	No
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

POST Request

Request body:

{
    "D": {
        "ListingKey": "20130718132609985967000000",
        "Comments": "This is a valid open house.",
        "Livestream":true,
        "LivestreamDate":"07/04/2020",
        "LivestreamStartTime":"8:00 am",
        "LivestreamEndTime":"12:00 pm",
        "LivestreamDescription":"This open house is available online!",
        "LivestreamUri":"https://zoom.us/my/livestream"
    }
}

POST Response

The standard success/fail response is returned.

Open Houses Description

Attribute	Data Type	Description
`Id`	Character	The unique id for the open house.
`ResourceUri`	Character	The URI to the particular open house.
`Date`	Character	The human readable starting date the open house is scheduled for. Note: For writes, we accept this field either as presented by this service (i.e. in the format "MM/DD/YYYY"), or as a typical Date type
`StartTime`	Character	The human readable starting time for the open house event. Note: For writes, we accept this field either as presented by this service (i.e. in the format "9:00 am"), or as a typical Timestamp type
`EndTime`	Character	The human readable ending time for the open house event. Note: For writes, we accept this field either as presented by this service (i.e. in the format "9:00 am"), or as a typical Timestamp type
`OpenHouseStartTimestamp`	Timestamp	The time the open house begins
`OpenHouseEndTimestamp`	Timestamp	The time the open house ends
`Comments`	Character	Additional information regarding the open house event.
`Livestream`	Boolean	If `true`, this is a livestream open house. For these types of events, `LivestreamDate`, `LivestreamStartTime`, and `LivestreamEndTime` will be used instead of `Date`, `StartTime`, and `EndTime`.
`LivestreamUri`	Character	The URI where the livestream open house will take place.
`LivestreamDescription`	Character	The description of the livestream event.
`LivestreamDate`	Character	The human readable starting date the livestream open house is scheduled for. Used instead of `Date` when `Livestream` is `true`.
`LivestreamStartTime`	Character	The human readable starting time for the livestream open house event. Used instead of `StartTime` when `Livestream` is `true`.
`LivestreamEndTime`	Character	The human readable ending time for the livestream open house event. Used instead of `EndTime` when `Livestream` is `true`.
`LivestreamStartTimestamp`	Timestamp	The starting time for the livestream open house event. Used instead of `OpenHouseStartTimestamp` when `Livestream` is `true`.
`LivestreamEndTimestamp`	Timestamp	The ending time for the livestream open house event. Used instead of `OpenHouseEndTimestamp` when `Livestream` is `true`.
`AdditionalInfo`	JSON Object	(Private Only) Additional information custom to the MLS for the open house, in the order of desired presentation. See the metadata service for details.

Expansions

None.