---
title: "Gross Rental Yield (Batch)"
method: POST
path: "/v2/state/hcri"
tags: ["State Level"]
---

# Gross Rental Yield (Batch)

`POST /v2/state/hcri`

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>

## Request body

- object[]
  - `state` string — 2-letter state abbreviation

## Response `200`

Success

- object[]
  - `state/hcri` object
    - `api_code_description` string
    - `api_code` unknown
    - `result` object, nullable
      - `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
  - `state_info` StateInfo
    - `state` string — 2-letter state abbreviation

## 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)