---
title: "Gross Rental Yield (Batch)"
method: POST
path: "/v2/blockgroup/hcri"
tags: ["Census Block Group Level"]
---

# Gross Rental Yield (Batch)

`POST /v2/blockgroup/hcri`

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>[].blockgroup_id</td><td>string</td><td>12-digit census block group ID</td><td>060750615003</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>

## Query parameters

- `property_type` 'SFD' | 'TH' | 'CND' | 'INC' | 'MFH'

## Request body

- object[]
  - `blockgroup_id` string, required — 12-digit census block group ID

## Response `200`

Success

- object[]
  - `blockgroup/hcri` object
    - `api_code_description` string
    - `api_code` unknown
    - `result` object, nullable
      - `property_type` 'SFD' | 'TH' | 'CND' | 'INC' | 'MFH' — Type of property specified in the request. Defaults to SFD.
      - `gross_yield_count` integer — Count of the properties that contributed to the index
      - `gross_yield_median` number — Median gross yield value
      - `gross_yield_average` number — Average gross yield value
  - `blockgroup_info` BlockgroupInfo
    - `block_id` string, nullable — 12-digit census block group ID

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/housecanary/apis/housecanary-analytics-and-portfolio-monitoring-apis.md) · [All operations](https://skmtc.net/housecanary/apis/housecanary-analytics-and-portfolio-monitoring-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/housecanary/housecanary-analytics-and-portfolio-monitoring-apis/revisions/38afb6724de7/schema)