Listings: Historical
The Historical Listings service returns previous and subsequent listings for the same property.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | No | |
| Public | Yes | No | |
| VOW | Yes | No | |
| Portal | Yes | No | |
| Private | Yes | No |
More information about roles may be found here.
Available Services
Historical Listings
/<API Version>/listings/<Listing.Id>/historical
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns all historical listings related to the specified listing. | 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 |
|---|---|---|
| Pagination | No |
GET Response
See the GET request section for for the Listings service.
Price History
/<API Version>/listings/<Listing.Id>/historical/pricehistory
The price history service combines the listing history for all historical listings in a single response. The results are ordered by ModificationTimestamp. Additionally, the events returned are limited to the on-market event, price change events, and the most recent status change event for each listing (BackOnMarket events, or StatusChange events when the listing became pending).
Only the most recent 50 listings for a property will be included in the price history.
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns the price history for all historical listings related to the specified listing. | 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 Listing History service.
Historical Listings Description
See the Response Format for the Listings service and the
Listing History service. This service also returns the
History.PriceChange attribute, which is also documented in the listing history service.
Expansions
None.