Skip to main content

Get Historical Rent Summary

Get historical rent data for a property over time, optionally compared against
geographic benchmarks (ZIP code, PUMA, MSA) fetched in parallel.

Use with only property_id for single-property historical trends.
Add zip_code, puma_code, or msa_code to compare against market averages.

Inputs​

ParameterRequiredTypeDetails
date_fromNoanyOfStart date in YYYY-MM-DD format (optional, defaults to 90 days ago)
Default: null
date_toNoanyOfEnd date in YYYY-MM-DD format (optional, defaults to today)
Default: null
msa_codeNoanyOfMSA code to get historical rent data for (optional)
Default: null
property_idYesstringThe ID of the property (required)
puma_codeNoanyOfPUMA code to get historical rent data for (optional)
Default: null
rent_typeNostringType of rent to retrieve - "ASKING" or "EFFECTIVE" (default: "ASKING")
Default: "ASKING"
Allowed: ["ASKING","EFFECTIVE"]
zip_codeNoanyOfZipcode to get historical rent data for (optional)
Default: null

Annotations​

{
"title": "Get Historical Rent Summary",
"readOnlyHint": true,
"destructiveHint": false,
"openWorldHint": false
}

Input schema​

{
"type": "object",
"additionalProperties": false,
"properties": {
"property_id": {
"type": "string",
"description": "The ID of the property (required)"
},
"zip_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Zipcode to get historical rent data for (optional)"
},
"puma_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "PUMA code to get historical rent data for (optional)"
},
"msa_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "MSA code to get historical rent data for (optional)"
},
"date_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date in YYYY-MM-DD format (optional, defaults to 90 days ago)"
},
"date_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date in YYYY-MM-DD format (optional, defaults to today)"
},
"rent_type": {
"default": "ASKING",
"enum": [
"ASKING",
"EFFECTIVE"
],
"type": "string",
"description": "Type of rent to retrieve - \"ASKING\" or \"EFFECTIVE\" (default: \"ASKING\")"
}
},
"required": [
"property_id"
]
}