RESO: Property
The Property resource accesses the same data as Spark's listings service
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. Property DELETE is limited to incomplete listings.
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 Properties
/Reso/OData/Property
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns the data for all properties accessible by the current user | 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 | |
| Searching parameters | No | |
| Sorting parameters | No | |
| Expansion parameter | No |
GET Response
Please review the documentation for the RESO Web API for an example response.
Individual Property
/Reso/OData/Property('<ListingKey>')
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Retrieves an individual property by Id | 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.
Property 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.
Expansions
| Expansion | Roles | Description |
|---|---|---|
GreenVerification |
All | Green verification fields for the property. |
Media |
All | Photo, Document, Video and Virtual tour data for the property. |
Room |
All | Room data for the property. |
Unit |
All | Unit data for the property. |
OpenHouse |
All | Open houses for the property. |
PowerProduction |
All | Power production fields for the property. |
HistoryTransactional |
All | History data for the property. |
RentalCalendar |
All | Array of dates for which the property is rented. |