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.

  1. Supported Roles
  2. Available Services
    1. All Upcoming Open Houses
    2. Individual Open House Event
  3. Open Houses 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 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",
                "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",
                "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",
                "Comments": "hunter",
                "AdditionalInfo": [
                    {
                        "Hosted By:": "Agent Hunter"
                    },
                    {
                        "Hosted Phone": ""
                    },
                    {
                        "Area": ""
                    }
                ]
            }
        ],
        "Success": true
    }
}

Open Houses Description

Attribute Data Type Searchable Description
Id Character No The unique id for the open house.
ResourceUri Character No The URI to the particular open house.
ListingKey Character Yes The ListingKey of the associated listing.
ModificationTimestamp Timestamp Yes The time when the open house was last modified.
Date Character No The human readable starting date the open house is scheduled for.
StartTime Character No The human readable starting time for the open house event.
EndTime Character No The human readable ending time for the open house event.
Comments Character No Additional information regarding the open house event.
AdditionalInfo JSON Object No (Private Only) Additional information custom to the MLS for the open house, in the order of desired presentation. See the Listings: Open House Metadata service for details.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.