---
title: "Value within Census Block (Batch)"
method: POST
path: "/v2/property/value_within_block"
tags: ["Property Level"]
---

# Value within Census Block (Batch)

`POST /v2/property/value_within_block`

Compare a property's value and value per sq ft within its block, providing context for local market positioning. 

Source: HouseCanary 

Pricing Tier: Basic 

Updated: Monthly

## Request Query Params

<table><tr><th>Property</th><th>Type</th><th>Description</th><th>Example</th></tr>
<tr><td>client_value</td><td>number</td><td>Dollar value supplied by the caller, to position within the distribution of property values within the block.</td><td>950000</td>
        </tr>
<tr><td>client_value_sqft</td><td>number</td><td>Dollar value per sq ft supplied by the caller, to position within the distribution of property values per sq ft within the block.</td><td></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. Defaults to SFD.</td><td>TH</td>
        <td>[SFD, TH, CND, INC, MFH]</td></tr>
<tr><td>housecanary_value_percentile_range</td><td>object</td><td>Percentile range information for the HouseCanary value.</td><td></td>
        <td></td></tr>
<tr><td>housecanary_value_percentile_range.name</td><td>string</td><td>Name of the range.</td><td>80th Percentile</td>
        <td></td></tr>
<tr><td>housecanary_value_percentile_range.high</td><td>integer</td><td>High percentile of the range.</td><td>400000</td>
        <td></td></tr>
<tr><td>housecanary_value_percentile_range.low</td><td>integer</td><td>Low percentile of the range.</td><td>300000</td>
        <td></td></tr>
<tr><td>housecanary_value_sqft_percentile_range</td><td>object</td><td>Percentile range information for the HouseCanary value per square foot.</td><td></td>
        <td></td></tr>
<tr><td>housecanary_value_sqft_percentile_range.name</td><td>string</td><td>Name of the range.</td><td>70th Percentile</td>
        <td></td></tr>
<tr><td>housecanary_value_sqft_percentile_range.high</td><td>integer</td><td>High percentile of the range.</td><td>300</td>
        <td></td></tr>
<tr><td>housecanary_value_sqft_percentile_range.low</td><td>integer</td><td>Low percentile of the range.</td><td>200</td>
        <td></td></tr>
<tr><td>client_value_percentile_range</td><td>object</td><td>Percentile range information for the client-provided value.</td><td></td>
        <td></td></tr>
<tr><td>client_value_percentile_range.name</td><td>string</td><td>Name of the range.</td><td>50th Percentile</td>
        <td></td></tr>
<tr><td>client_value_percentile_range.high</td><td>integer</td><td>High percentile of the range.</td><td>320000</td>
        <td></td></tr>
<tr><td>client_value_percentile_range.low</td><td>integer</td><td>Low percentile of the range.</td><td>280000</td>
        <td></td></tr>
<tr><td>client_value_sqft_percentile_range</td><td>object</td><td>Percentile range information for the client-provided value per square foot.</td><td></td>
        <td></td></tr>
<tr><td>client_value_sqft_percentile_range.name</td><td>string</td><td>Name of the range.</td><td>60th Percentile</td>
        <td></td></tr>
<tr><td>client_value_sqft_percentile_range.high</td><td>integer</td><td>High percentile of the range.</td><td>280</td>
        <td></td></tr>
<tr><td>client_value_sqft_percentile_range.low</td><td>integer</td><td>Low percentile of the range.</td><td>240</td>
        <td></td></tr>
</table>

## Query parameters

- `client_value` number, nullable
- `client_value_sqft` number, nullable

## Request body

- object[]
  - `slug` string — Unique readable string identifier for the property
  - `address` string, required — 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)
  - `unit` string — Unit number for the property, if needed and not already specified in the address string
  - `city` string — City in which the property is located
  - `state` string — 2-letter acronym of the US state in which the property is located
  - `zipcode` string — 5-digit US zipcode in which the property is located

## Response `200`

Success

- object[]
  - `property/value_within_block` object
    - `api_code_description` string
    - `api_code` unknown
    - `result` object, nullable
      - `property_type` 'SFD' | 'TH' | 'CND' | 'INC' | 'MFH' — Type of property. Defaults to SFD.
      - `housecanary_value_percentile_range` object — Percentile range information for the HouseCanary value.
        - `name` string — Name of the range.
        - `high` integer, nullable — High percentile of the range.
        - `low` integer, nullable — Low percentile of the range.
      - `housecanary_value_sqft_percentile_range` object — Percentile range information for the HouseCanary value per square foot.
        - `name` string — Name of the range.
        - `high` integer, nullable — High percentile of the range.
        - `low` integer, nullable — Low percentile of the range.
      - `client_value_percentile_range` object, nullable — Percentile range information for the client-provided value.
        - `name` string — Name of the range.
        - `high` integer, nullable — High percentile of the range.
        - `low` integer, nullable — Low percentile of the range.
      - `client_value_sqft_percentile_range` object, nullable — Percentile range information for the client-provided value per square foot.
        - `name` string — Name of the range.
        - `high` integer, nullable — High percentile of the range.
        - `low` integer, nullable — Low percentile of the range.
  - `address_info` AddressInfo
    - `address_full` string, nullable — Full address string
    - `slug` string, nullable — HouseCanary address slug
    - `address` string, nullable — Street address
    - `unit` string, nullable — Unit within the building, if any
    - `city` string, nullable — City where property is located
    - `state` string, nullable — 2-character state abbreviation
    - `zipcode` string, nullable — 5-character US zipcode
    - `zipcode_plus4` string, nullable — 4-character zipcode extension
    - `block_id` string, nullable — 15-digit US census block ID
    - `blockgroup_id` string, nullable — 12-digit census block group ID
    - `county_fips` string, nullable — 5-digit US census county ID
    - `metrodiv` string, nullable — 5-digit US census Metropolitan Division ID
    - `msa` string, nullable — 5-digit US census MSA ID
    - `geo_precision` 'rooftop' | 'parcel' | 'zip9' | 'zip5' | 'unknown', nullable — A string describing available geo precision
    - `lat` number, nullable — Latitude value, in degrees
    - `lng` number, nullable — Longitude value, in degrees
    - `status` object
      - `match` boolean — Whether the address was matched to a canonical address in HouseCanary's systems
      - `details` string[]
      - `requested_item` object — Exact address parameters provided in the original API request
      - `changes` string[]
      - `errors` string[]

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