State Level
Gross Rental Yield (Batch)
Calculate the Canary Rental Index (CRI) to measure aggregated gross rental yield across a State, enabling assessment of rental market performance within a specific block.
Gross rental yield is calculated per-property as the ( monthly rental AVM * 12 ) / property value AVM.
Pricing Tier: Premium
Request Body Fields
<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr> <tr><td>[]</td><td>object</td><td></td><td></td> </tr> <tr><td>[].state</td><td>string</td><td>2-letter state abbreviation</td><td>CA</td> </tr> </table>Response
<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr> <tr><td>gross_yield_count</td><td>integer</td><td>Count of the properties that contributed to the index</td><td>250</td> </tr> <tr><td>gross_yield_median</td><td>number</td><td>Median gross yield value</td><td>8.2</td> </tr> <tr><td>gross_yield_average</td><td>number</td><td>Average gross yield value</td><td>7.9</td> </tr> </table>post/v2/state/hcri
Request body
Example request
[
{
"state": "CA"
}
]Response
Success
Example response
[
{
"state/hcri": {
"result": {
"gross_yield_count": 250,
"gross_yield_median": 8.2,
"gross_yield_average": 7.9
}
},
"state_info": {
"state": "CA"
}
}
]