Gross Rental Yield (Batch)

Calculate the Canary Rental Index (CRI) to measure aggregated gross rental yield across a block, enabling assessment of rental market performance within a specific block.

Gross rental yield is calculated per-property as the monthly rental AVM * 12 / sale price AVM.

Source: HouseCanary

Pricing Tier: Premium

Updated: Monthly

Request Query Params

<table><tr><th>Property</th><th>Type</th><th>Description</th><th>Example</th><th>Enum Values</th></tr> <tr><td>property_type</td><td>string</td><td>Desired property type to aggregate. Defaults to SFD.</td><td>TH</td> <td>[SFD, TH, CND, INC, MFH]</td></tr> </table>

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>[].block_id</td><td>string</td><td>15-digit US-census block ID</td><td>360050001001000</td> </tr> </table>

Response

<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th><th>Enum Values</th></tr> <tr><td>property_type</td><td>string</td><td>Type of property specified in the request. Defaults to SFD.</td><td>TH</td> <td>[SFD, TH, CND, INC, MFH]</td></tr> <tr><td>gross_yield_count</td><td>integer</td><td>Count of the properties that contributed to the index</td><td>250</td> <td></td></tr> <tr><td>gross_yield_median</td><td>number</td><td>Median gross yield value</td><td>8.2</td> <td></td></tr> <tr><td>gross_yield_average</td><td>number</td><td>Average gross yield value</td><td>7.9</td> <td></td></tr> </table>

[
  {
    "block_id": "360050001001000"
  }
]

[
  {
    "block/hcri": {
      "result": {
        "property_type": "TH",
        "gross_yield_count": 250,
        "gross_yield_median": 8.2,
        "gross_yield_average": 7.9
      }
    },
    "block_info": {
      "block_id": "360050001001000"
    }
  }
]