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:
value: The predicted selling price.
low: The lowest expected selling price.
high: The highest expected selling price.
confidence: The predicted error as a percentage. A lower value indicates higher confidence in the prediction.
date: The date the estimate was generated.
history: Historical predicted selling prices for the last 24 months.
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.
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:
{
"estimate": {
"value": 756032.8125,
"date": "2024-07-09T00:10:30.639Z",
"high": 813998.5057848413,
"low": 698067.1192151587,
"confidence": 0.076670869738,
"history": {
"mth": {
"2022-09": { "value": 727216.625 },
"2024-04": { "value": 753425.375 },
"2023-02": { "value": 740498.875 },
"2022-12": { "value": 727203.0625 },
"2024-03": { "value": 753584.375 },
"2023-03": { "value": 743368.125 },
"2024-06": { "value": 755687.1875 },
"2023-04": { "value": 755727.4375 },
"2024-05": { "value": 755142.3125 },
"2023-05": { "value": 757856.5 },
"2023-06": { "value": 756460.875 },
"2024-07": { "value": 756032.8125 },
"2023-07": { "value": 751060.875 },
"2023-08": { "value": 747515.125 },
"2023-09": { "value": 744308.5625 },
"2022-08": { "value": 726073.375 },
"2023-10": { "value": 740463.9375 },
"2024-02": { "value": 750526.8125 },
"2023-11": { "value": 739458.375 },
"2022-10": { "value": 727212.875 },
"2024-01": { "value": 742255.625 },
"2023-12": { "value": 740722.375 },
"2023-01": { "value": 729112.125 },
"2022-11": { "value": 727366 }
}
}
}
}
Attributes:
value: The predicted selling price.
low: The lowest expected selling price.
high: The highest expected selling price.
confidence: The predicted error as a percentage. A lower value indicates higher confidence in the prediction.
date: The date the estimate was generated.
history: Historical predicted selling prices for the last 24 months.
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.
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: 09/07/2024
Thank you!