RESO: OpenHouse
The OpenHouse resource returns upcoming open house data, either for all Property listings in the current user's MLS, or for a given Property. Be aware that only public, in person open houses are returned by default. See Usage Notes for more information on how to retrieve broker open and livestream open houses.
For Version 3 POST, PATCH, and DELETE operations, see the Add/Edit developer guide. The GET reference below also applies to read-only clients. Writes require Dictionary 2.0 and appropriate listing/resource permissions. Writes require private with the required client keyrole, or private_full without operation-specific keyrole requirements; see Add/Edit access requirements.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | No | |
| Public | Yes | No | |
| VOW | Yes | No | |
| Portal | Yes | No | |
| Private | Yes | Yes |
More information about roles may be found here.
Available Services
All OpenHouses
/Reso/OData/OpenHouse
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Retrieves all upcoming open houses in the current user's MLS | 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 |
|---|---|---|
| Attribute selection parameters | No | |
| Pagination parameters | No |
GET Response
Please review the documentation for the RESO Web API for an example response.
All OpenHouses for a Property
/Reso/OData/Property('<ListingKey>')/OpenHouse
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Retrieves all upcoming open houses for a given listing | No | |
| POST | Version 3 Add/Edit. See the developer guide for access, requests, and responses. | No | Dictionary 2.0; see guide for permissions and If-Match support. |
| 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 |
|---|---|---|
| Attribute selection parameters | No | |
| Pagination parameters | No |
GET Response
Please review the documentation for the RESO Web API for an example response.
Specific OpenHouse Record
/Reso/OData/OpenHouse/('<OpenHouseKey>')
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Retrieves an individual open house record by 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:
| Parameter | Required | Notes |
|---|---|---|
| Attribute selection parameters | No |
GET Response
Please review the documentation for the RESO Web API for an example response.
Specific OpenHouse Record for a Property
/Reso/OData/Property('<ListingKey>')/OpenHouse('<OpenHouseKey>')
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Retrieves an individual open house record by Id as a subresource of a Property | No | |
| POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
| PUT | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
| DELETE | Version 3 Add/Edit. See the developer guide for access, requests, and responses. | Optional If-Match | Dictionary 2.0; see guide for permissions and If-Match support. |
| PATCH | Version 3 Add/Edit. See the developer guide for access, requests, and responses. | Optional If-Match | Dictionary 2.0; see guide for permissions and If-Match support. |
GET Request
Parameters:
| Parameter | Required | Notes |
|---|---|---|
| Attribute selection parameters | No |
GET Response
Please review the documentation for the RESO Web API for an example response.
OpenHouse Description
This service uses the RESO Data Dictionary. Please review the currently supported dictionary on our overview page as well as the data dictionary documentation provided by RESO.
Usage Notes
-
There are four OpenHouseTypes. By default, only
Publicopen houses are returned with open house data. To retrieve the other types (Broker,Livestream Public, &Livestream Broker), they must be explicitly requested using a filter parameter:GET https://replication.sparkapi.com/Version/3/Reso/OData/OpenHouse?$filter=OpenHouseType in ('Broker','Livestream Public','Livestream Broker') -
The OpenHouse expansion on the Property resource can also be filtered:
GET https://replication.sparkapi.com/Version/3/Reso/OData/Property?$expand=OpenHouse($filter=OpenHouseType in ('Public','Broker','Livestream Public','Livestream Broker'))
Expansions
None.