Enhancements in V2 of Our Listings Model
If you started using our APIs before July 24, 2024, you might be interested to learn about the enhancements we made to our listing model. These changes were not applied to existing accounts automatically, as they would have caused breaking changes. However, if you wish to take advantage of these enhancements, we can provide a new API key or adjust the configuration on your existing API key.
We initially assumed that all MLSs provided timestamps in UTC, but this was not the case. Previously, a timestamp like "2024-09-15T11:40:14.000Z" indicated UTC time due to the "Z" suffix. In reality, this could have been a local time. To address this, V2 uses a zero offset format to denote local times correctly, e.g., "2024-09-15T11:40:14.000-00:00".
The initial version of our listing model used nested numbered objects for open houses, rooms, and bathrooms, which could be cumbersome to parse. For example:
In V2, we've transitioned to using arrays, which offer better consistency and easier integration:
We corrected a spelling mistake in the previous version where "Amenities" was incorrectly spelled as "Ammenities." The correct spelling is now used throughout the model.
Numeric values were previously represented inconsistently as strings. For example:
In V2, all numeric values are consistently represented as integers:
Null values were inconsistently represented as empty strings in the earlier version. For example:
In V2, null values are correctly formatted using null:
In the previous version, all listings contained a "condominium" object, regardless of whether the listing class was "condo." In V2, only listings classified as condos will include this object, improving data relevance and clarity.
The formatting of open house times did not follow the ISO datetime standard in the earlier model. For instance:
In V2, all open house times are formatted according to ISO datetime standards:
To explore and benefit from these improvements, you can either request a new API key configured for the V2 listing model or ask us to modify your current API key settings. Please contact our support team for assistance in transitioning to the updated version.
By adopting V2 of our listings model, you'll ensure better data consistency, clarity, and compatibility with the latest standards, leading to more seamless integration and usage of our APIs.
Timestamp Accuracy
We initially assumed that all MLSs provided timestamps in UTC, but this was not the case. Previously, a timestamp like "2024-09-15T11:40:14.000Z" indicated UTC time due to the "Z" suffix. In reality, this could have been a local time. To address this, V2 uses a zero offset format to denote local times correctly, e.g., "2024-09-15T11:40:14.000-00:00".
Use of Arrays for Open House, Rooms, and Bathrooms
The initial version of our listing model used nested numbered objects for open houses, rooms, and bathrooms, which could be cumbersome to parse. For example:
"rooms": {
"1": {...},
"2": {...}
}In V2, we've transitioned to using arrays, which offer better consistency and easier integration:
"rooms": [
{ "description": "Media", ... },
{ "description": "Primary Bedroom", ... }
]Corrected Spelling of Amenities
We corrected a spelling mistake in the previous version where "Amenities" was incorrectly spelled as "Ammenities." The correct spelling is now used throughout the model.
Consistent Formatting of Numeric Values
Numeric values were previously represented inconsistently as strings. For example:
"numBedrooms": "1"In V2, all numeric values are consistently represented as integers:
"numBedrooms": 1Consistent Formatting of Null Values
Null values were inconsistently represented as empty strings in the earlier version. For example:
"swimmingPool": ""In V2, null values are correctly formatted using null:
"swimmingPool": nullCondominium Object Specificity
In the previous version, all listings contained a "condominium" object, regardless of whether the listing class was "condo." In V2, only listings classified as condos will include this object, improving data relevance and clarity.
Open House Start and End Time Formatting
The formatting of open house times did not follow the ISO datetime standard in the earlier model. For instance:
"startTime": "2:00 PM",
"endTime": "5:00 PM"In V2, all open house times are formatted according to ISO datetime standards:
"startTime": "2023-10-29T14:00:00.000-00:00",
"endTime": "2023-10-29T17:00:00.000-00:00"How to Access These Enhancements
To explore and benefit from these improvements, you can either request a new API key configured for the V2 listing model or ask us to modify your current API key settings. Please contact our support team for assistance in transitioning to the updated version.
By adopting V2 of our listings model, you'll ensure better data consistency, clarity, and compatibility with the latest standards, leading to more seamless integration and usage of our APIs.
Updated on: 15/09/2024
Thank you!