Market

Get qualified regional Zillow context for a property

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. Only the trusted served parcel supplies ZIP/county/state. Caller-supplied geography/CBSA is rejected; there is no inferred metro match. canonical_id is omitted when rights prevent parcel lookup.

get/api/v1/market/zillow/context

Request

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

Query parameters

parcel_idstring required

Canonical or legacy county5 parcel identity. The server derives trusted geography after source-use approval.

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

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

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.

metricsstring

Comma-separated unique metric names; defaults to all five. Duplicate names rejected.

window_months'12' | '36' | '60' | '120' | '600'

Number of calendar months displayed (600 = full available history); missing months remain gaps.

Response

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

schemaVersion'zillow-market-v1' required
status'available' | 'partial' | 'unavailable' required
canonical_idstring
reasonstring nullable required

Changes

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