Market

Get one provider region monthly series

Requires API-key or first-party session authentication and a current account in the default-off server cohort. Valid current membership does not require a new paid subscription. Existing API quotas still apply. Responses are private, no-store. Unknown and repeated query parameters are rejected. This contract does not indicate source activation, deployment or an SDK release. Use-specific, unexpired reviewed Zillow rights are checked before parcel resolution or repository/cache access. Denied/unknown rights return explicit unavailable metric values, not substitute data. Each metric exposes actual regional geography/variant and freshness; regional values do not become parcel estimates or residual inputs. Provider region IDs are not FIPS/CBSA codes. Explicit selection remains regional, not a property mapping. Range is ordered and limited to600 monthly periods.

get/api/v1/market/zillow/timeseries

Request

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

Query parameters

dataset_keystring required

Exact enabled dataset registry key (for example zori_metro_monthly); unknown keys rejected.

region_idstring required

Explicit Zillow provider region identifier.

start_periodstring required

Inclusive first calendar month.

end_periodstring required

Inclusive final calendar month; at most599 months after start.

as_ofstring date-time

Optional explicit-offset timestamp for the accepted source vintage known at that time. Future/invalid times rejected; unavailable historical vintages are not reconstructed from current data.

use'display' | 'agent' | 'export'

Requested use; checked against current source rights. Agent use is not an external send.

Response

Authorized result; unavailable/partial/stale states are explicit within the response. No live coverage is implied by this contract.

metric'zori' | 'zhvi' | 'inventory' | 'price_cut_share' | 'median_days_to_pending' required
status'available' | 'unavailable' required
reasonstring nullable required
definitionstring required
unit'usd' | 'usd_per_month' | 'count' | 'fraction' | 'days' required
valuenumber nullable required
periodstring nullable required
sourceUrlstring required
attributionstring required

Changes

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