Properties

Create Property

Register a property. Resolves the postcode via postcodes.io (once) and warms the global HPI index cache for its location. Pro feature: property tracking requires a paid tier (existing properties keep working after a downgrade — only adding new ones is gated).

post/api/properties

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/properties
  • Auth: HTTP bearer

Request body

postcodestring required
property_type'detached' | 'semi_detached' | 'terraced' | 'flat' required
purchase_monthstring date required
nicknamestring nullable
uprnstring nullable

Response

Successful Response

idstring required
nicknamestring nullable required
postcodestring required
admin_districtstring nullable required
regionstring nullable required
property_typestring required
purchase_pricenumber required
purchase_monthstring required
mortgage_balancenumber nullable required
estimated_valuenumber nullable required
equitynumber nullable required
index_month_usedstring nullable required
location_level_usedstring nullable required
is_activeboolean required
created_atstring required
attributionstring required
valuation_sourcestring nullable
valuation_datestring nullable
valuation_confidencestring nullable
valuation_lower_boundstring nullable
valuation_upper_boundstring nullable
manual_valuenumber nullable
uprnstring nullable
value_labelstring nullable
needs_valueboolean
pmi_verdictstring nullable
pmi_rejected_reasonstring nullable
pmi_checked_atstring nullable
pmi_estimate_seennumber nullable
pmi_estimate_confidencestring nullable
pmi_estimate_lower_boundnumber nullable
pmi_estimate_upper_boundnumber nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.