AI-Powered Property Estimates Implementation Guide
Our real estate APIs offer an AI-Powered Property Estimates feature, providing AI-generated price predictions for properties. This feature allows users to gain valuable insights into property values, both for listed and off-market properties. Homeowners and sellers can use these predictions to understand their buying power or equity position, helping them make more informed decisions.
For every listed property, an AI-generated price prediction is provided. An "estimate" object will be added to each listing when using the 'Search Listings' or 'Get A Single Listing' endpoints.
Predictions include a range (high and low estimates) and a confidence level.
Users can request estimates for off-market properties by submitting a JSON request containing the property's attributes using the 'Create Estimate' endpoint.
Useful for understanding buying power or equity position and for creating What's My Home Worth?* experiences.
Option to send immediate or monthly emails to clients with estimate details.
Enhances user engagement and retention.
The estimate object includes a history of predicted selling prices for the past 24 months.
Enables visualization of historical property values for both On-Market and Off-Market property estimates.
Here’s an example of what an estimate object looks like:
estimate: The predicted selling price.
estimateLow: The lowest expected selling price.
estimateHigh: The highest expected selling price.
confidence: The predicted error as a percentage. A lower value indicates higher confidence in the prediction.
createdOn: The date the estimate was generated.
updatedOn: The date the estimate was updated.
history: Historical predicted selling prices for the last 24 months.
payload: the object that was sent to Estimate endpoint to generate the returned estimate
Endpoint: POST /estimates
Description: Create a property estimate by submitting a JSON request containing the property’s attributes. This endpoint isl for obtaining predictions for off-market properties.
When a clientId is supplied during an estimate request, users can choose to:
sendEmailNow: Immediately send an email to the client with a link to the estimate details.
sendEmailMonthly: Send monthly emails to the client with links to the estimate details, enhancing user retention.
Endpoint: PATCH /estimates/{estimateId}
Description: Update details related to an existing estimate. This endpoint allows for adjustments to reflect changes in property attributes, such as an increase in property taxes.
Endpoint: GET /estimates
Description: Retrieve estimates created with clientId context. This endpoint is useful for managing a client’s property portfolio, allowing you to list all their properties and select specific estimates.
Endpoint: DELETE /estimates/{estimateId}
Description: Delete an existing estimate.
For a complete list of supported endpoints and parameters, please refer to our API reference.
TypeScript types for the Estimate endpoints can be found here
To start using the AI-Powered Property Estimates feature please reach out to your account manager and request access to this addon.
For any additional assistance, please contact our support team.
Key Features
On-Market Property Estimates
For every listed property, an AI-generated price prediction is provided. An "estimate" object will be added to each listing when using the 'Search Listings' or 'Get A Single Listing' endpoints.
Predictions include a range (high and low estimates) and a confidence level.
Off-Market Property Estimates
Users can request estimates for off-market properties by submitting a JSON request containing the property's attributes using the 'Create Estimate' endpoint.
Useful for understanding buying power or equity position and for creating What's My Home Worth?* experiences.
Integrated Messaging Support For Off-Market Property Estimates
Option to send immediate or monthly emails to clients with estimate details.
Enhances user engagement and retention.
Historical Value Visualization
The estimate object includes a history of predicted selling prices for the past 24 months.
Enables visualization of historical property values for both On-Market and Off-Market property estimates.
Estimate Object Breakdown
Here’s an example of what an estimate object looks like:
{
"estimateId": 123,
"clientId": 12345,
"createdOn": "2024-11-26T20:18:32.000Z",
"updatedOn": "2024-12-23T18:56:40.000Z",
"estimate": 508597.59375,
"estimateHigh": 577311.2033262489,
"estimateLow": 439883.9841737512,
"confidence": 0.135104079179,
"payload": {
"boardId": 12,
"resource": "Property:6585",
"address": {
"city": "Ottawa",
"streetName": "XXXXX",
"streetNumber": "62",
"streetSuffix": "CRES",
"zip": "XXX XXX"
},
"details": {
"basement1": "Full",
"exteriorConstruction1": "Brick",
"extras": " ",
"heating": "hot water",
"numBathrooms": "2",
"numBedrooms": "2",
"numParkingSpaces": 2,
"propertyType": "Detached",
"sqft": "1700",
"style": "2 Storey",
"yearBuilt": 1917
},
"taxes": {
"annualAmount": 3433
},
"map": {
"latitude": 45.111111,
"longitude": -75.22222
},
"condominium": {},
"lot": {
"width": "8"
}
},
"sendEmailMonthly": true,
"history": {
"mth": {
"2024-12": {
"value": 508597.59375
},
"2024-11": {
"value": 508491.09375
},
"2024-10": {
"value": 511354.3125
},
"2024-09": {
"value": 515547.1875
},
"2024-08": {
"value": 518630
},
"2024-07": {
"value": 517877.4375
},
"2024-06": {
"value": 521343.40625
},
"2024-05": {
"value": 528593.8125
},
"2024-04": {
"value": 529295.3125
},
"2024-03": {
"value": 528415.4375
},
"2024-02": {
"value": 527182.6875
},
"2024-01": {
"value": 515970.59375
},
"2023-12": {
"value": 501919.1875
},
"2023-11": {
"value": 496545.84375
},
"2023-10": {
"value": 494088.0625
},
"2023-09": {
"value": 503897
},
"2023-08": {
"value": 518545.90625
},
"2023-07": {
"value": 519646.1875
},
"2023-06": {
"value": 517748.25
},
"2023-05": {
"value": 515325.90625
},
"2023-04": {
"value": 499442.75
},
"2023-03": {
"value": 491507.3125
},
"2023-02": {
"value": 483552.6875
},
"2023-01": {
"value": 484527.65625
}
}
}
}
Attributes:
estimate: The predicted selling price.
estimateLow: The lowest expected selling price.
estimateHigh: The highest expected selling price.
confidence: The predicted error as a percentage. A lower value indicates higher confidence in the prediction.
createdOn: The date the estimate was generated.
updatedOn: The date the estimate was updated.
history: Historical predicted selling prices for the last 24 months.
payload: the object that was sent to Estimate endpoint to generate the returned estimate
Endpoints
Create An Estimate
Endpoint: POST /estimates
Description: Create a property estimate by submitting a JSON request containing the property’s attributes. This endpoint isl for obtaining predictions for off-market properties.
Messaging Integration
When a clientId is supplied during an estimate request, users can choose to:
sendEmailNow: Immediately send an email to the client with a link to the estimate details.
sendEmailMonthly: Send monthly emails to the client with links to the estimate details, enhancing user retention.
Update An Estimate
Endpoint: PATCH /estimates/{estimateId}
Description: Update details related to an existing estimate. This endpoint allows for adjustments to reflect changes in property attributes, such as an increase in property taxes.
Get Estimates
Endpoint: GET /estimates
Description: Retrieve estimates created with clientId context. This endpoint is useful for managing a client’s property portfolio, allowing you to list all their properties and select specific estimates.
Delete An Estimate
Endpoint: DELETE /estimates/{estimateId}
Description: Delete an existing estimate.
Estimate API Reference
For a complete list of supported endpoints and parameters, please refer to our API reference.
TypeScript types for the Estimate endpoints can be found here
Getting Started
To start using the AI-Powered Property Estimates feature please reach out to your account manager and request access to this addon.
For any additional assistance, please contact our support team.
Updated on: 23/12/2024
Thank you!