Propalt API

Valuation

Endpoint:https://propalt-api-live-main-5e2d419.zuplo.app

Get Valuation By Property ID

POST

https://propalt-api-live-main-5e2d419.zuplo.app

/valuation/get-valuation-by-property-id

Look up property features by property_id, merge with client overrides, and retrieve AVM valuation.

Get Valuation By Property ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Valuation By Property ID › Request Body

Input for get_valuation_by_property_id endpoint. Looks up property features from DB by property_id, then merges with optional client overrides (client values take priority when not null). Cross-validation rules (applied after DB merge in the endpoint): - If property_type is 'bungalow' or 'house', built_form must be one of: detached, semi_detached, terraced. - If property_type is 'flat', built_form must be one of: flat, maisonette, studio. Note on postcode: accepts outward code only (e.g. 'SA11', 'NW3'), case-insensitive.

property_id

integer · required

Propalt inner property key.

Outward postcode only (e.g. 'SA11', 'NW3'). Case-insensitive. Overrides DB value if provided.

type

string · enum

Query type: 'selling' for sales valuation, 'letting' for rental valuation.

Enum values:

selling

letting

Default: selling

Number of bedrooms (1–20). Overrides DB value if provided.

Total floor area in square metres (10–600). Overrides DB value if provided.

Property type. Overrides DB value if provided.

Built form / sub-type. Overrides DB value if provided.

Get Valuation By Property ID › Responses

Valuation result with prediction bands

Output schema for get_valuation_by_property_id endpoint (documentation only). Reuses SubjectPropertyFeature for the subject property features. Do NOT use as response_model — return plain dicts from endpoints.

object · required

The subject property features used for the valuation.

object · required

Valuation prediction with confidence bands.

running_id

integer · required

Unique identifier for this valuation run.

POST/valuation/get-valuation-by-property-id

curl --request POST \
  --url https://propalt-api-live-main-5e2d419.zuplo.app/valuation/get-valuation-by-property-id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "property_id": 23360841,
  "postcode": "SA11",
  "type": "selling",
  "num_beds": 3,
  "total_floor_area": 86,
  "property_type": "house",
  "built_form": "semi_detached"
}
'

shell

Example Request Body

{
  "property_id": 23360841,
  "postcode": "SA11",
  "type": "selling",
  "num_beds": 3,
  "total_floor_area": 86,
  "property_type": "house",
  "built_form": "semi_detached"
}

json

Example Responses

{
  "subject_property_feature": {
    "property_id": 23360841,
    "property_type": "house",
    "built_form": "semi_detached",
    "num_beds": 3,
    "postcode": "SA11 2LR",
    "query_type": "selling",
    "total_floor_area": 86
  },
  "valuation_result": {
    "predict_price": 129500,
    "predict_price_up_band": 148000,
    "predict_price_low_band": 110500,
    "confidence_level": 6,
    "price_per_sqm": 0,
    "price_per_bedroom": 43166,
    "target_property_lat": 51.6364123,
    "target_property_lng": -3.8296254
  },
  "running_id": 59278187
}

json

application/json

Comparables Address Search

Get Valuation By Property ID

POST

https://propalt-api-live-main-5e2d419.zuplo.app

/valuation/get-valuation-by-property-id

Look up property features by property_id, merge with client overrides, and retrieve AVM valuation.

Get Valuation By Property ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Valuation By Property ID › Request Body

property_id

integer · required

Propalt inner property key.

Outward postcode only (e.g. 'SA11', 'NW3'). Case-insensitive. Overrides DB value if provided.

type

string · enum

Query type: 'selling' for sales valuation, 'letting' for rental valuation.

Enum values:

selling

letting

Default: selling

Number of bedrooms (1–20). Overrides DB value if provided.

Total floor area in square metres (10–600). Overrides DB value if provided.

Property type. Overrides DB value if provided.

Built form / sub-type. Overrides DB value if provided.

Get Valuation By Property ID › Responses

Valuation result with prediction bands

object · required

The subject property features used for the valuation.

object · required

Valuation prediction with confidence bands.

running_id

integer · required

Unique identifier for this valuation run.

curl --request POST \ --url https://propalt-api-live-main-5e2d419.zuplo.app/valuation/get-valuation-by-property-id \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "property_id": 23360841, "postcode": "SA11", "type": "selling", "num_beds": 3, "total_floor_area": 86, "property_type": "house", "built_form": "semi_detached" } '

{ "subject_property_feature": { "property_id": 23360841, "property_type": "house", "built_form": "semi_detached", "num_beds": 3, "postcode": "SA11 2LR", "query_type": "selling", "total_floor_area": 86 }, "valuation_result": { "predict_price": 129500, "predict_price_up_band": 148000, "predict_price_low_band": 110500, "confidence_level": 6, "price_per_sqm": 0, "price_per_bedroom": 43166, "target_property_lat": 51.6364123, "target_property_lng": -3.8296254 }, "running_id": 59278187 }