RESO API RELEASE & UPDATE LOG
Update for Future January 2024 Release:
Notes for Upcoming Release 12-22-23:
RMLS applied API field changes to many data feeds. RMLS recommends pulling down an updated metadata field to see what changes were applied to your API data feed.
Notes for Upcoming Release 12-8-23:
RMLS will deploy significant changes to our database and forms as part of a project termed Forms Change 2023 (FC2023).
- FC2023 Release Date: 1/10/24
- Expected Service Outage: 1/9/24 (6:00 PM to 6:00 AM on 1/10/24)
As part of the FC2023 project, we are implementing changes such as adding, renaming, and modifying fields, as well as updating enumeration values for numerous lookup fields. To facilitate this process, we have made an older, static copy of our Staging Environment for you to access and review these modification changes. The staging environment is currently open, containing Active listing data, although ongoing delta changes are not expected to occur regularly. An email containing the staging environment URL and instructions on accessing the data has been sent to existing service providers.
For your convenience, we have supplied downloadable documentation that outlines the planned changes within the comprehensive metadata file. At this time, please access the staging environment, retrieve the updated API Metadata, and modify your query scripts/programs as needed to prepare for the upcoming production deployment. However, please be aware that this documentation is not data feed specific, and not all modifications will be reflected in the metadata you are authorized to receive.
Update Released 12-14-22:
The RMLS RESO Web API, now provides a field for each resource, containing the datetime of the most recent change to individual records.
Resource | DataType | StandardName |
Property | Timestamp | PropertyRecordUpdateTimestamp |
Member | Timestamp | MemberRecordUpdateTimestamp |
Office | Timestamp | OfficeRecordUpdateTimestamp |
OpenHouse | Timestamp | OpenHouseRecordUpdateTimestamp |
Media | Timestamp | MediaRecordUpdateTimestamp |
PropertyGreenVerification | Timestamp | GreenVerificationRecordUpdateTimestamp |
The ModificationTimestamp tracks user edits to a record in the RMLS source system. It does not track all changes that may occur for a record, such as, system administrative, corrective, or statistical data.
The <resource>RecordUpdateTimestamp reflects any change made to a record, and it reflects the datetime that the change become available on the Web API, not the datetime the data was adjusted in the RMLS source system.
For example, DaysOnMarket (DOM) is a statistical value the system calculates each day in the early morning, Pacific Time. DOM is calculated for listings having StandardStatus of ‘Active’ and ‘Active Under Contract’ and with PropertyType of ‘Residential’, ‘Multi Family,’ or ‘Commercial Sale’. A DOM change does not adjust the ModificationTimestamp, but it will adjust the PropertyRecordUpdateTimestamp.
An effect of using the PropertyRecordUpdateTimestamp field to check for updated records is that each morning all listings with a DOM value have a new datetime value for this field.
Because this is a new field, existing records will have <resource>RecordUpdateTimestamp initialized with each record’s ModificationTimestamp. This should avoid triggering a download of all existing records should you shift to using the new field to drive updating your local copy of RMLS data. Subsequent to the code release, any change to existing records in RMLS data will result in setting <resource>RecordUpdateTimestamp to the datetime the updated record is made available in the Web API.
Updates Released 8-9-2022
RESO Updates for CancelationDate, DataTime, PropertyGreenVerification, Purge Records, and UnparsedAddress
- The Property resource CancelationDate changed to CancellationDate to match the RESO standard name.
- All DateTime and Timestamp fields changed from UTC TZ format.
- ex: 2022-04-17T13:45:22.632Z to Pacific Time Zone with offset from UTC time format (ex: 2022-04-17T06:45:22-07:00)
- Or, when not involving a daylight timestamp: 2020-01-11T06:21:05-08:00
- The PropertyGreenVerification resource GreenBuildingVerificationKey field value changed and the GreenBuildingVerificationKeyNumeric field removed.
- A bug that causing PropertyGreenVerification duplicate records fixed.
- Purge records updated to filter out Incomplete status listings.
- Previously, RMLS did not make Incomplete status listings available through data feeds. This will substantially reduce the number of listings reported in the Purged resource.
- UnitNumber added to UnparsedAddress.
- Metadata updated to reflect to name the change to CancellationDate and removal of GreenVerificationKeyNumeric
- Resource TimestampModified updated to reflect the above updates affected all available resources (Deleted, Media, Member, Office, OpenHouse, Property, PropertyGreenVerification)
Updates Released 8-9-2022
RESO Updates for CancelationDate, DataTime, PropertyGreenVerification, Purge Records, and UnparsedAddress
- The Property resource CancelationDate changed to CancellationDate to match the RESO standard name.
- All DateTime and Timestamp fields changed from UTC TZ format.
- ex: 2022-04-17T13:45:22.632Z to Pacific Time Zone with offset from UTC time format (ex: 2022-04-17T06:45:22-07:00)
- Or, when not involving a daylight timestamp: 2020-01-11T06:21:05-08:00
- The PropertyGreenVerification resource GreenBuildingVerificationKey field value changed and the GreenBuildingVerificationKeyNumeric field removed.
- A bug that causing PropertyGreenVerification duplicate records fixed.
- Purge records updated to filter out Incomplete status listings.
- Previously, RMLS did not make Incomplete status listings available through data feeds. This will substantially reduce the number of listings reported in the Purged resource.
- UnitNumber added to UnparsedAddress.
- Metadata updated to reflect to name the change to CancellationDate and removal of GreenVerificationKeyNumeric
- Resource TimestampModified updated to reflect the above updates affected all available resources (Deleted, Media, Member, Office, OpenHouse, Property, PropertyGreenVerification)
Updates Released 6-30-2022
Implement changes to enable using TZ offset in queries
- The user will be able to query for datetimes using either the format 2022-06-03T21:10:58.990Z or format 2022-06-03T14:10:58.990-07:00.
- Note: The datetime returned will be in the format 2022-06-03T21:10:58.990Z (TZ 00:00
- Media resource datetime values updated to be consistent with all other Resource datetimes (UTC TZ 00:00).
Updates Released 6-16-2022
- Timestamps updated for https://resoapi.rmlsweb.com/reso/odata/Resource endpoint.
- The timestamps returned will reflect the last update time for the various Resources.
Example:
{
"@odata.context": "$metadata#Resource",
"value": [
{
"TimeZoneOffset": -7,
"RName": "Media",
"DSName": "WEB_API",
"ResourcePath": "/Media",
"Description": "Media",
"TimestampModified": "2022-06-13T19:04:28.05Z"
},
{
"TimeZoneOffset": -7,
"RName": "Member",
"DSName": "WEB_API",
"ResourcePath": "/Member",
"Description": "Member",
"TimestampModified": "2022-06-13T19:04:28.05Z"
},
{
"TimeZoneOffset": -7,
...
- Media datetime changes were removed from the deployment, and the Media datetime values are still Pacific TZ.
- Additional Key fields added to the Property, Member and Office resources. These additional fields assist in querying and joining resources.
- Corrections made to metadata reported by the RESO API system – https://resoapi.rmlsweb.com/reso/odata/$metadata endpoint.
Find the updated fields in this PDF.
Updated Fields:
Resource | DataType | StandardName | SuggestedMaxLength | SuggestedMaxPrecision |
Property | String | BuyerAgentKey | 255 | 0 |
Property | String | BuyerMainOfficeKey | 255 | 0 |
Property | String | CoListMainOfficeKey | 255 | 0 |
Property | String | ListMainOfficeKey | 255 | 0 |
Member | String | MainOfficeKey | 255 | 0 |
Office | Number | OfficeKeyNumeric | 16 | 0 |
New Fields:
New | New | New | old | old | Old | ||
---|---|---|---|---|---|---|---|
Resource | StandardName | DataType | SugMaxLen | SugMaxPrecision | DataType | SugMaxLen | SugMaxPrecision |
Property | LeasePriceCurrent1 | Number | 16 | 2 | String | 20 | 2 |
Property | LeasePriceCurrent2 | Number | 16 | 2 | String | 20 | 2 |
Property | LeasePriceCurrent3 | Number | 16 | 2 | String | 20 | 2 |
Property | LeasePriceCurrent4 | Number | 16 | 2 | String | 20 | 2 |
Property | LeasePriceCurrent5 | Number | 16 | 2 | String | 20 | 2 |
Property | PriceRatioListToSale | Number | 16 | 2 | String | 20 | 2 |
Property | PriceRatioOrigToSale | Number | 16 | 2 | String | 20 | 2 |
Property | SoldPricePerSquareFeet | Number | 16 | 2 | String | 20 | 2 |
Property | AuctionAssessedPrice | Number | 16 | 2 | Number | 4 | 0 |
Property | BuyerMainOfficeKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Property | ClosePrice | Number | 16 | 2 | Number | 14 | 2 |
Property | CoListMainOfficeKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Property | CoListMainOfficeKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Property | GrossRentMultiplier | Number | 16 | 2 | Number | 20 | 2 |
Property | HomeWarrantyPrice | Number | 16 | 2 | Number | 4 | 0 |
Property | ListMainOfficeKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Property | ListingKeyNumeric | Number | 16 | 2 | Number | 255 | 0 |
Property | ListPrice | Number | 16 | 2 | Number | 14 | 2 |
Property | ListPriceHigh | Number | 16 | 2 | Number | 4 | 0 |
Property | ListPriceLow | Number | 16 | 2 | Number | 14 | 2 |
Property | OriginalListPrice | Number | 16 | 2 | Number | 14 | 2 |
Property | OriginalListPriceHigh | Number | 16 | 2 | Number | 4 | 0 |
Property | OriginalListPriceLow | Number | 16 | 2 | Number | 4 | 0 |
Property | PreviousListPrice | Number | 16 | 2 | Number | 14 | 2 |
Property | PriceComments | String | 255 | 0 | String | 72 | 0 |
Property | PriceRatioOrigToSale | Number | 16 | 2 | Number | 20 | 2 |
Property | PriceRatioOrigToSale | Number | 16 | 2 | Number | 20 | 2 |
Property | SoldPricePerSquareFeet | Number | 16 | 2 | Number | 20 | 2 |
Property | StreetNumberNumeric | Number | 16 | 0 | Number | 255 | 0 |
Property | ListOfficeKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Member | MainOfficeKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Member | MemberKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Office | MainOfficeKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Office | OfficeBrokerKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Office | OfficeBrokerKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
OpenHouse | ListingKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
OpenHouse | OpenHouseKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
OpenHouse | ShowingAgentKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Media | MainOfficeKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Media | MediaKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
Media | ResourceRecordKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
PropertyGreenVerification | GreenBuildingVerificationKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |
PropertyGreenVerification | ListingKeyNumeric | Number | 16 | 0 | Number | 255 | 0 |