Storefront

Machine Storefront -- try-before-buy (jurisdiction coverage or per-parcel quote)

Try-before-buy at two scopes, both FREE and answered from the sealed catalog:

JURISDICTION mode (pass ?state=, optional &county=): how complete each field is in that state/county side-by-side with the national average, plus the worst local gaps and the base dossier quote. No parcel scan.

PARCEL mode (pass ?parcel_id=): the exact value-tiered dossier price for ONE parcel BEFORE paying, with the V/R/F multiplier breakdown, band, and the cheap signals it was derived from. This uses the SAME quote math as the x402 402 on /parcels/{id}/report, so the previewed price equals the amount the payer is charged. Does one light, indexed single-parcel read.

Provide EITHER parcel_id OR state. Same access model as the catalog: authenticated callers unmetered/uncapped, anonymous callers served and IP-throttled.

get/api/v1/storefront/availability

Request

  • Base URL: https://propraven.com
  • URL: https://propraven.com/api/v1/storefront/availability
  • Auth: one of:
    • HTTP bearer
    • none

Query parameters

parcel_idstring
Example:37:119:12104406

PARCEL mode. A canonical state_fips:county_fips:parcel_id, a legacy 5-digit-county:parcel_id, or a parcel UUID. When present, returns the value-tiered dossier quote for this parcel (state/county are ignored).

statestring
Example:NC

JURISDICTION mode. USPS code ("NC") or 2-digit FIPS ("37"). Required unless parcel_id is given.

countystring
Example:37183

3-digit within-state code ("183") or 5-digit state+county ("37183"). Optional; narrows JURISDICTION mode to one county.

limitinteger

JURISDICTION mode only: cap on the returned county list (default 25, max 400).

Response

JURISDICTION mode: coverage for the jurisdiction plus the base dossier quote. PARCEL mode: the value-tiered per-parcel dossier quote.

contract_versionnumber required
catalog_versionstring required
generated_atstring required
mode'parcel'

'parcel' in PARCEL mode; absent in JURISDICTION mode.

Example response

{
  "dossier_quote": {
    "price": {
      "amount": "5.00",
      "currency": "USD"
    },
    "asset": "USDC"
  }
}

Changes

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