Gross Rental Yield From Address (Batch)

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

Gross rental yield is calculated per-property as the ( monthly rental AVM * 12 ) / property value 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></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>[].slug</td><td>string</td><td>Unique readable string identifier for the property</td><td>123-Main-St-Apt-1B-San-Francisco-CA-94132</td> </tr> <tr><td>[].address</td><td>string</td><td>Either a single URL-safe string ("slug") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)</td><td>123 Main St</td> </tr> <tr><td>[].unit</td><td>string</td><td>Unit number for the property, if needed and not already specified in the address string</td><td>Apt 1B</td> </tr> <tr><td>[].city</td><td>string</td><td>City in which the property is located</td><td>San Francisco</td> </tr> <tr><td>[].state</td><td>string</td><td>2-letter acronym of the US state in which the property is located</td><td>CA</td> </tr> <tr><td>[].zipcode</td><td>string</td><td>5-digit US zipcode in which the property is located</td><td>94105</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>

[
  {
    "slug": "123-Main-St-Apt-1B-San-Francisco-CA-94132",
    "address": "123 Main St",
    "unit": "Apt 1B",
    "city": "San Francisco",
    "state": "CA",
    "zipcode": "94105"
  }
]

[
  {
    "property/blockgroup_hcri": {
      "result": {
        "property_type": "TH",
        "gross_yield_count": 250,
        "gross_yield_median": 8.2,
        "gross_yield_average": 7.9
      }
    },
    "address_info": {
      "address_full": "123 Main St San Francisco CA 94132",
      "slug": "123-Main-St-Apt-1B-San-Francisco-CA-94132",
      "address": "123 Main St",
      "unit": "Apt 1B",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94132",
      "zipcode_plus4": "1234",
      "block_id": "060750313013007",
      "blockgroup_id": "060750201004",
      "county_fips": "06075",
      "metrodiv": "41860",
      "msa": "41860",
      "geo_precision": "rooftop",
      "lat": 37.789,
      "lng": -122.401,
      "status": {
        "match": true,
        "details": [
          "Address fully verified"
        ],
        "requested_item": {
          "zipcode": "94132",
          "address": "123+Main+St"
        },
        "changes": [
          "State added or changed"
        ]
      }
    }
  }
]