Deals

County-quarter transaction summary or affordability index

Default: returns county/quarter transaction summaries. Pass view=affordability to retrieve the home-affordability index instead (price-to-income ratios + rating).

get/api/v1/deals/market

Request

  • Base URL: https://propraven.com
  • URL: https://propraven.com/api/v1/deals/market
  • Auth: HTTP bearer

Query parameters

view'affordability'

Switch to the affordability-index dataset.

county_fipsstring

5-digit county FIPS filter.

state_fipsstring

2-digit state FIPS filter.

yearstring
Example:2024

Year filter.

rating'AFFORDABLE' | 'MODERATE' | 'EXPENSIVE' | 'VERY_EXPENSIVE'

Affordability-rating filter (only meaningful with view=affordability). Case-insensitive; any other value is a 400.

limitinteger

Page size, max 500.

offsetinteger

Pagination offset.

Response

Market summary or affordability rows returned. Shape varies with the view parameter.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.