predict_endpoint
Predict property values over time. Billed per predicted value, which is one field on one date for one property. Required: property_id, start_date, fields. Find the property_id first with search_endpoint or properties_endpoint. Supports batch requests and parameter overrides for scenario testing.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"api_key": "<api_key>",
"property_id": "<property_id>",
"fields": "<fields>",
"start_date": "<start_date>"
},
"name": "predict_endpoint"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| last | No | Periods before start_date to include. A range reaching before 2021-01-01 is refused | |
| next | No | Periods after start_date to include. A range reaching past today is refused, because the models do not forecast | |
| fields | Yes | Fields to predict: "estimate_sale_price", "estimate_list_price", "estimate_rent_monthly" | |
| period | No | Time granularity: "day", "week", "month" (default), "year" | |
| api_key | Yes | API key for authentication | |
| overrides | No | What-if changes to the property before predicting, for scenario testing. Anything left out keeps the property's real value. | |
| start_date | Yes | Reference date in YYYY-MM-DD format, from 2021-01-01 to today | |
| price_quote | No | Return the cost of this request without billing it or returning data | |
| property_id | Yes | Property ID(s), comma-separated for batch requests |