Propalt API

Market Activity

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

Get House Price Index

GET

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

/market-activity/get-hpi

Retrieve UK House Price Index data for a postcode at Authority or Region geographic level.

Get House Price Index › query Parameters

postcode

string · pattern: ^(?i)([A-Z]{1,2}\d[A… · required

statistic_region

string · enum

Enum values:

Authority

Region

Default: Authority

statistic_time

integer · min: 1 · max: 10

Default: 3

Get House Price Index › 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 House Price Index › Responses

UK House Price Index data by postcode at Authority or Region level

Output schema for get_hpi endpoint (documentation only). Do NOT use as response_model — return plain dicts from endpoints.

level

string · required

Geographic level of the data: 'Authority' or 'Region'.

The year and month to which the monthly statistics apply.

Name of geography (Country, Regional, County/Unitary/District Authority and London Borough).

Code of geography (Country, Regional, County/Unitary/District Authority and London Borough).

Average house price for a geography in a particular period.

House price index for a geography in a particular period (January 2015=100).

Seasonally adjusted house price index (January 2015=100).

Percentage change in Average Price compared to previous month.

Percentage change in Average Price compared to same period twelve months earlier.

Seasonally adjusted Average Price for a geography in a particular period.

Number of registered transactions for a geography in a particular period.

Average house price for a Detached House.

House price index for Detached House (January 2015=100).

Percentage change in Detached Price compared to previous month.

Percentage change in Detached Price compared to same period twelve months earlier.

Average house price for a Semi-Detached House.

House price index for Semi-Detached House (January 2015=100).

Percentage change in Semi-Detached Price compared to previous month.

Percentage change in Semi-Detached Price compared to same period twelve months earlier.

Average house price for a Terraced House.

House price index for Terraced House (January 2015=100).

Percentage change in Terraced Price compared to previous month.

Percentage change in Terraced Price compared to same period twelve months earlier.

Average house price for a Flat/Maisonette.

House price index for Flat/Maisonette (January 2015=100).

Percentage change in Flat Price compared to previous month.

Percentage change in Flat Price compared to same period twelve months earlier.

Average house price by funding status 'CASH'.

House price index by funding status 'CASH' (January 2015=100).

Percentage change in Cash Price compared to previous month.

Percentage change in Cash Price compared to same period twelve months earlier.

Number of registered transactions 'CASH'.

Average house price by funding status 'MORTGAGE'.

House price index by funding status 'MORTGAGE' (January 2015=100).

Percentage change in Mortgage Price compared to previous month.

Percentage change in Mortgage Price compared to same period twelve months earlier.

Number of registered transactions 'MORTGAGE'.

Average house price by buyer status 'first time buyer'.

House price index by buyer status 'first time buyer' (January 2015=100).

Percentage change in FTB Price compared to previous month.

Percentage change in FTB Price compared to same period twelve months earlier.

Average house price by buyer status 'former owner occupier'.

House price index by buyer status 'former owner occupier' (January 2015=100).

Percentage change in FOO Price compared to previous month.

Percentage change in FOO Price compared to same period twelve months earlier.

Average house price by property status 'new build'.

House price index by property status 'new build' (January 2015=100).

Percentage change in New Price compared to previous month.

Percentage change in New Price compared to same period twelve months earlier.

Number of registered transactions 'New'.

Average house price by property status 'existing build'.

House price index by property status 'existing build' (January 2015=100).

Percentage change in Old Price compared to previous month.

Percentage change in Old Price compared to same period twelve months earlier.

Number of registered transactions 'Old'.

GET/market-activity/get-hpi

curl --request GET \
  --url 'https://propalt-api-live-main-5e2d419.zuplo.app/market-activity/get-hpi?postcode=%3Cstring%3E' \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "level": "Authority",
  "stat_month": "2025-11",
  "region_name": "Camden",
  "area_code": "E09000007",
  "avg_price": "785420",
  "hpi_index": 142.8,
  "hpi_index_sa": "141.5",
  "change_1m": "0.8",
  "change_12m": "3.2",
  "avg_price_sa": "780150",
  "sales_volume": "245",
  "detached_price": "2450000",
  "detached_index": 138.5,
  "detached_change_1m": "0.5",
  "detached_change_12m": "2.8",
  "semidetached_price": "1350000",
  "semidetached_index": 145.2,
  "semidetached_change_1m": "0.9",
  "semidetached_change_12m": "3.5",
  "terraced_price": "1150000",
  "terraced_index": 148.6,
  "terraced_change_1m": "1.1",
  "terraced_change_12m": "4.0",
  "flat_maisonette_price": "625000",
  "flat_maisonette_index": 135.8,
  "flat_maisonette_change_1m": "0.6",
  "flat_maisonette_change_12m": "2.5",
  "cash_price": "820000",
  "cash_index": 140.2,
  "cash_change_1m": "0.7",
  "cash_change_12m": "2.9",
  "cash_sales_volume": "85",
  "mortgage_price": "765000",
  "mortgage_index": 144.5,
  "mortgage_change_1m": "0.9",
  "mortgage_change_12m": "3.4",
  "mortgage_sales_volume": "160",
  "ftb_price": "545000",
  "ftb_index": 152.3,
  "ftb_change_1m": "1.2",
  "ftb_change_12m": "4.5",
  "foo_price": "895000",
  "foo_index": 138.9,
  "foo_change_1m": "0.6",
  "foo_change_12m": "2.7",
  "new_price": "920000",
  "new_index": 128.4,
  "new_change_1m": "0.4",
  "new_change_12m": "1.8",
  "new_sales_volume": "18",
  "existing_price": "775000",
  "existing_index": 145.1,
  "existing_change_1m": "0.9",
  "existing_change_12m": "3.5",
  "existing_sales_volume": "227"
}

json

application/json

Get Listings

POST

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

/market-activity/get-listings

Retrieve property listing events with flexible filtering by postcode, listing type, event progress, date ranges, price, and property features.

Get Listings › 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 Listings › Request Body

Input for get_listings endpoint. Retrieves property listing events filtered by area, type, progress, date, price, and features. Exactly one of first_postcode or postcode is required.

Outward code (first part of postcode), e.g. 'SW1A'. Provide either this or postcode, not both.

Full UK postcode, e.g. 'SW1A 1AA'. Provide either this or first_postcode, not both.

type

string · enum

Listing type: 'all' (sales+rentals), 'sale' (sales only), 'rent' (rentals only).

Enum values:

all

sale

rent

Default: all

progress

string

Event status filter. Valid values depend on 'type': type=all: all, reduction, for_sale, withdrawn, sstc_letAgree, sold_let. type=sale: all, reduction, for_sale, withdrawn, sstc, sold, all_sale. type=rent: all, reduction, for_sale, withdrawn, letAgree, let, all_let.

Default: all

Filter on event (progress) date. Format: 'DDMMYYYY' for single date, 'DDMMYYYY-DDMMYYYY' for date range. E.g. '01012025' or '01012025-31012025'. This filters the event date based on the selected progress type (e.g. if progress=reduction, this filters the reduction date period).

Minimum event (progress) date filter (inclusive). Format: 'DDMMYYYY'. E.g. '01012025' → events on or after 2025-01-01. Takes priority over period.

Maximum event (progress) date filter (exclusive). Format: 'DDMMYYYY'. E.g. '31012025' → events before 2025-01-31. Takes priority over period.

Filter on original listed date (first event date for the listing). Format: 'DDMMYYYY' or 'DDMMYYYY-DDMMYYYY'.

Price filter. Single value: '250000'. Range: '250000-500000'.

Minimum price filter (inclusive). E.g. 250000. Takes priority over price.

Maximum price filter (exclusive). E.g. 500000. Takes priority over price.

matched

integer · enum

0 = all listings (default), 1 = only listings linked to a known property.

Enum values:

Default: 0

feature

string · enum

Feature filter: 'all' (no filter), 'discount' (discounted properties), 'shared' (shared ownership), 'hmo' (HMO/student), 'retirement' (retirement properties).

Enum values:

all

discount

shared

hmo

retirement

Default: all

limit

integer · min: 1 · max: 100

Number of results per page. Default 100, max 100.

Default: 100

page

integer · min: 0

0-based page index. Offset = page * limit. Default 0.

Default: 0

Get Listings › Responses

Property listing events filtered by area, type, progress, date, price, and features

Output schema for get_listings endpoint (documentation only). Do NOT use as response_model — return plain dicts from endpoints.

Internal ID allocated to a property.

Date the event took place.

Unique listing identifier.

Type of price request such as offers_in_excess_of, etc.

The asking price for sale or rent.

Is the property new-build or re-sale.

Description of the property's key features.

The organisation brand name responsible for the event (e.g. agency brand).

The organisation branch name responsible for the event.

The price the property was first listed for.

The price after a price reduction.

Date a property was last registered as sold on the official registrar.

Price a property was sold for on the official registrar.

The ID type of listing: 1 = Sale, 2 = Rent.

The deposit required as a rental bond.

Type of listing: Sale or Rent.

The type of building use such as house or flat.

The build type such as semi-detached, terrace, or detached.

Number of floor plans on the portal listing.

Number of images on the portal listing.

Number of videos on the portal listing.

Whether the listing is marketed as premium on property portals.

Number of bedrooms.

1 if listing is believed to be sold below potential market value (discount, refurbishment, or un-mortgageable).

1 if shared ownership (key worker / family income below £80k, government co-ownership).

1 if house of multiple occupancy (typically rented room-by-room, may require licence).

1 if retirement home (lease restricts occupants to over 55).

1 if identified as an auction listing (price may be below final achieved / market value).

1 if a probate property.

1 if chain free property.

1 if investment property.

1 if the house has a conservatory room.

URL of the listing house image.

Current status of the property (e.g. Reduced, Withdrawn, Sold).

Listing type name.

Number identifying the premise on a thoroughfare.

Name of residential or commercial premise.

Individual unit name (flat, apartment, business unit).

Royal Mail assigned town.

Unique Property Reference Number.

Street or road name. Uses address_street if property_id is NULL.

Property number.

Building number.

Building latitude.

Building longitude.

Royal Mail assigned postal code.

Date the listing was first published.

Number of residents at the property.

Number of email contacts for the property.

Number of mobile phone contacts for the property.

Number of landline phone contacts for the property.

POST/market-activity/get-listings

curl --request POST \
  --url https://propalt-api-live-main-5e2d419.zuplo.app/market-activity/get-listings \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_postcode": "string",
  "postcode": "string",
  "type": "all",
  "progress": "progress",
  "period": "string",
  "min_period": "string",
  "max_period": "string",
  "listedat": "string",
  "price": "string",
  "min_price": 0,
  "max_price": 0,
  "matched": 0,
  "feature": "all",
  "limit": 0,
  "page": 0
}
'

shell

Example Request Body

{
  "first_postcode": "string",
  "postcode": "string",
  "type": "all",
  "progress": "progress",
  "period": "string",
  "min_period": "string",
  "max_period": "string",
  "listedat": "string",
  "price": "string",
  "min_price": 0,
  "max_price": 0,
  "matched": 0,
  "feature": "all",
  "limit": 0,
  "page": 0
}

json

Example Responses

{
  "property_id": 19436848,
  "event_date": "2025-10-15 09:30:00",
  "listing_id": 8842156,
  "price_qualifier": "guide_price",
  "price": 685000,
  "listing_condition": "resale",
  "key_features": "Period conversion, high ceilings, bay windows, share of freehold, close to Hampstead Heath",
  "brand_name": "Hampstead Residential",
  "branch_name": "Hampstead",
  "first_listed_price": 725000,
  "recent_reduced_price": 685000,
  "last_sold_date": "2006-12-01",
  "last_sold_price": 528250,
  "listing_type_id": 1,
  "deposit": "",
  "letting_type": "Sale",
  "property_type": "house",
  "built_form": "terraced",
  "num_floorPlans": "1",
  "num_images": "12",
  "num_videos": "1",
  "isPremium": "true",
  "num_beds": 2,
  "discount_property": 0,
  "shared_ownership": 0,
  "HMO": 0,
  "retirement_property": 0,
  "auction_property": 0,
  "probate_property": 0,
  "chain_free_property": 1,
  "investment_property": 0,
  "conservatory": "0",
  "front_image_url": "https://media.rightmove.co.uk/12345/67890_1.jpg",
  "listing_status": "Reduced",
  "listing_type": "Sale",
  "building_number": "14",
  "building_name": "",
  "sub_building_name": "Flat 2",
  "town": "LONDON",
  "uprn": "10091866843",
  "thoroughfare": "BELSIZE PARK",
  "poan": "14",
  "soan": "FLAT 2",
  "lat": 51.5590384,
  "lng": -0.1775866,
  "postcode": "NW3 1AA",
  "listed_date": "2025-09-01 10:00:00",
  "resident_count": 2,
  "email_count": 1,
  "mobile_count": 2,
  "landline_count": 1
}

json

application/json

Get Sold Properties

GET

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

/market-activity/get-sold-properties

Retrieve sold property records by outward code or full postcode.

Get Sold Properties › query Parameters

first_postcode

postcode

limit

integer · min: 1 · max: 100

Default: 100

page

integer · min: 0

Default: 0

Get Sold Properties › 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 Sold Properties › Responses

Sold property records for a postcode area

Output schema for get_sold_properties endpoint (documentation only). Do NOT use as response_model — return plain dicts from endpoints.

property_id

integer · required

Internal id allocated to a property.

Date the event took place.

Sold price of the listing.

GET/market-activity/get-sold-properties

curl --request GET \
  --url https://propalt-api-live-main-5e2d419.zuplo.app/market-activity/get-sold-properties \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "property_id": 19436848,
  "date": "2006-12-01 00:00:00",
  "price": 528250
}

json

application/json

Get Property History

GET

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

/market-activity/get-property-history

Retrieve full event history for a property by property_id.

Get Property History › query Parameters

property_id

integer · required

Get Property History › 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 Property History › Responses

Property event history including sales, listings, and status changes

Output schema for get_property_history endpoint (documentation only). Do NOT use as response_model — return plain dicts from endpoints.

property_id

integer · required

Internal id allocated to a property.

The asking price for sale or rent if there is a recorded event of a listing.

Date the event took place.

The current status of the property such as Reduced, Withdrawn, Sold if there is a recorded event of a listing.

The Brand Name of the agent associated with the event, e.g. 'LandRegistry'.

An internal ID allocated to a agent brand associated with an event, e.g. 'lr01'.

URL link to the property listing on the source portal (Rightmove or Zoopla).

The listing identifier from the source portal.

The portal source code, e.g. 'RMP' for Rightmove.

GET/market-activity/get-property-history

curl --request GET \
  --url 'https://propalt-api-live-main-5e2d419.zuplo.app/market-activity/get-property-history?property_id=%3Cnumber%3E' \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "property_id": 19436848,
  "price": 685000,
  "date": "2025-10-15 09:30:00",
  "status": "Reduced",
  "source": "Hampstead Residential",
  "sourceId": "agt_4521",
  "portal_link": "https://www.rightmove.co.uk/properties/123456789",
  "listing_id": "8842156",
  "portal_source": "RMP"
}

json

application/json

Market & Analytics Organisation

Get House Price Index

GET

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

/market-activity/get-hpi

Retrieve UK House Price Index data for a postcode at Authority or Region geographic level.

Get House Price Index › query Parameters

postcode

string · pattern: ^(?i)([A-Z]{1,2}\d[A… · required

statistic_region

string · enum

Enum values:

Authority

Region

Default: Authority

statistic_time

integer · min: 1 · max: 10

Default: 3

Get House Price Index › 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 House Price Index › Responses

UK House Price Index data by postcode at Authority or Region level

Output schema for get_hpi endpoint (documentation only). Do NOT use as response_model — return plain dicts from endpoints.

level

string · required

Geographic level of the data: 'Authority' or 'Region'.

The year and month to which the monthly statistics apply.

Name of geography (Country, Regional, County/Unitary/District Authority and London Borough).

Code of geography (Country, Regional, County/Unitary/District Authority and London Borough).

Average house price for a geography in a particular period.

House price index for a geography in a particular period (January 2015=100).

Seasonally adjusted house price index (January 2015=100).

Percentage change in Average Price compared to previous month.

Percentage change in Average Price compared to same period twelve months earlier.

Seasonally adjusted Average Price for a geography in a particular period.

Number of registered transactions for a geography in a particular period.

Average house price for a Detached House.

House price index for Detached House (January 2015=100).

Percentage change in Detached Price compared to previous month.

Percentage change in Detached Price compared to same period twelve months earlier.

Average house price for a Semi-Detached House.

House price index for Semi-Detached House (January 2015=100).

Percentage change in Semi-Detached Price compared to previous month.

Percentage change in Semi-Detached Price compared to same period twelve months earlier.

Average house price for a Terraced House.

House price index for Terraced House (January 2015=100).

Percentage change in Terraced Price compared to previous month.

Percentage change in Terraced Price compared to same period twelve months earlier.

Average house price for a Flat/Maisonette.

House price index for Flat/Maisonette (January 2015=100).

Percentage change in Flat Price compared to previous month.

Percentage change in Flat Price compared to same period twelve months earlier.

Average house price by funding status 'CASH'.

House price index by funding status 'CASH' (January 2015=100).

Percentage change in Cash Price compared to previous month.

Percentage change in Cash Price compared to same period twelve months earlier.

Number of registered transactions 'CASH'.

Average house price by funding status 'MORTGAGE'.

House price index by funding status 'MORTGAGE' (January 2015=100).

Percentage change in Mortgage Price compared to previous month.

Percentage change in Mortgage Price compared to same period twelve months earlier.

Number of registered transactions 'MORTGAGE'.

Average house price by buyer status 'first time buyer'.

House price index by buyer status 'first time buyer' (January 2015=100).

Percentage change in FTB Price compared to previous month.

Percentage change in FTB Price compared to same period twelve months earlier.

Average house price by buyer status 'former owner occupier'.

House price index by buyer status 'former owner occupier' (January 2015=100).

Percentage change in FOO Price compared to previous month.

Percentage change in FOO Price compared to same period twelve months earlier.

Average house price by property status 'new build'.

House price index by property status 'new build' (January 2015=100).

Percentage change in New Price compared to previous month.

Percentage change in New Price compared to same period twelve months earlier.

Number of registered transactions 'New'.

Average house price by property status 'existing build'.

House price index by property status 'existing build' (January 2015=100).

Percentage change in Old Price compared to previous month.

Percentage change in Old Price compared to same period twelve months earlier.

Number of registered transactions 'Old'.

{ "level": "Authority", "stat_month": "2025-11", "region_name": "Camden", "area_code": "E09000007", "avg_price": "785420", "hpi_index": 142.8, "hpi_index_sa": "141.5", "change_1m": "0.8", "change_12m": "3.2", "avg_price_sa": "780150", "sales_volume": "245", "detached_price": "2450000", "detached_index": 138.5, "detached_change_1m": "0.5", "detached_change_12m": "2.8", "semidetached_price": "1350000", "semidetached_index": 145.2, "semidetached_change_1m": "0.9", "semidetached_change_12m": "3.5", "terraced_price": "1150000", "terraced_index": 148.6, "terraced_change_1m": "1.1", "terraced_change_12m": "4.0", "flat_maisonette_price": "625000", "flat_maisonette_index": 135.8, "flat_maisonette_change_1m": "0.6", "flat_maisonette_change_12m": "2.5", "cash_price": "820000", "cash_index": 140.2, "cash_change_1m": "0.7", "cash_change_12m": "2.9", "cash_sales_volume": "85", "mortgage_price": "765000", "mortgage_index": 144.5, "mortgage_change_1m": "0.9", "mortgage_change_12m": "3.4", "mortgage_sales_volume": "160", "ftb_price": "545000", "ftb_index": 152.3, "ftb_change_1m": "1.2", "ftb_change_12m": "4.5", "foo_price": "895000", "foo_index": 138.9, "foo_change_1m": "0.6", "foo_change_12m": "2.7", "new_price": "920000", "new_index": 128.4, "new_change_1m": "0.4", "new_change_12m": "1.8", "new_sales_volume": "18", "existing_price": "775000", "existing_index": 145.1, "existing_change_1m": "0.9", "existing_change_12m": "3.5", "existing_sales_volume": "227" }

Get Listings

POST

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

/market-activity/get-listings

Retrieve property listing events with flexible filtering by postcode, listing type, event progress, date ranges, price, and property features.

Get Listings › 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 Listings › Request Body

Input for get_listings endpoint. Retrieves property listing events filtered by area, type, progress, date, price, and features. Exactly one of first_postcode or postcode is required.

Outward code (first part of postcode), e.g. 'SW1A'. Provide either this or postcode, not both.

Full UK postcode, e.g. 'SW1A 1AA'. Provide either this or first_postcode, not both.

type

string · enum

Listing type: 'all' (sales+rentals), 'sale' (sales only), 'rent' (rentals only).

Enum values:

all

sale

rent

Default: all

progress

string

Default: all

Minimum event (progress) date filter (inclusive). Format: 'DDMMYYYY'. E.g. '01012025' → events on or after 2025-01-01. Takes priority over period.

Maximum event (progress) date filter (exclusive). Format: 'DDMMYYYY'. E.g. '31012025' → events before 2025-01-31. Takes priority over period.

Filter on original listed date (first event date for the listing). Format: 'DDMMYYYY' or 'DDMMYYYY-DDMMYYYY'.

Price filter. Single value: '250000'. Range: '250000-500000'.

Minimum price filter (inclusive). E.g. 250000. Takes priority over price.

Maximum price filter (exclusive). E.g. 500000. Takes priority over price.

matched

integer · enum

0 = all listings (default), 1 = only listings linked to a known property.

Enum values:

Default: 0

feature

string · enum

Feature filter: 'all' (no filter), 'discount' (discounted properties), 'shared' (shared ownership), 'hmo' (HMO/student), 'retirement' (retirement properties).

Enum values:

all

discount

shared

hmo

retirement

Default: all

limit

integer · min: 1 · max: 100

Number of results per page. Default 100, max 100.

Default: 100

page

integer · min: 0

0-based page index. Offset = page * limit. Default 0.

Default: 0

Get Listings › Responses

Property listing events filtered by area, type, progress, date, price, and features

Output schema for get_listings endpoint (documentation only). Do NOT use as response_model — return plain dicts from endpoints.

Internal ID allocated to a property.

Date the event took place.

Unique listing identifier.

Type of price request such as offers_in_excess_of, etc.

The asking price for sale or rent.

Is the property new-build or re-sale.

Description of the property's key features.

The organisation brand name responsible for the event (e.g. agency brand).

The organisation branch name responsible for the event.

The price the property was first listed for.

The price after a price reduction.

Date a property was last registered as sold on the official registrar.

Price a property was sold for on the official registrar.

The ID type of listing: 1 = Sale, 2 = Rent.

The deposit required as a rental bond.

Type of listing: Sale or Rent.

The type of building use such as house or flat.

The build type such as semi-detached, terrace, or detached.

Number of floor plans on the portal listing.

Number of images on the portal listing.

Number of videos on the portal listing.

Whether the listing is marketed as premium on property portals.

Number of bedrooms.

1 if listing is believed to be sold below potential market value (discount, refurbishment, or un-mortgageable).

1 if shared ownership (key worker / family income below £80k, government co-ownership).

1 if house of multiple occupancy (typically rented room-by-room, may require licence).

1 if retirement home (lease restricts occupants to over 55).

1 if identified as an auction listing (price may be below final achieved / market value).

1 if a probate property.

1 if chain free property.

1 if investment property.

1 if the house has a conservatory room.

URL of the listing house image.

Current status of the property (e.g. Reduced, Withdrawn, Sold).

Listing type name.

Number identifying the premise on a thoroughfare.

Name of residential or commercial premise.

Individual unit name (flat, apartment, business unit).

Royal Mail assigned town.

Unique Property Reference Number.

Street or road name. Uses address_street if property_id is NULL.

Property number.

Building number.

Building latitude.

Building longitude.

Royal Mail assigned postal code.

Date the listing was first published.

Number of residents at the property.

Number of email contacts for the property.

Number of mobile phone contacts for the property.

Number of landline phone contacts for the property.

curl --request POST \ --url https://propalt-api-live-main-5e2d419.zuplo.app/market-activity/get-listings \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "first_postcode": "string", "postcode": "string", "type": "all", "progress": "progress", "period": "string", "min_period": "string", "max_period": "string", "listedat": "string", "price": "string", "min_price": 0, "max_price": 0, "matched": 0, "feature": "all", "limit": 0, "page": 0 } '

{ "first_postcode": "string", "postcode": "string", "type": "all", "progress": "progress", "period": "string", "min_period": "string", "max_period": "string", "listedat": "string", "price": "string", "min_price": 0, "max_price": 0, "matched": 0, "feature": "all", "limit": 0, "page": 0 }

{ "property_id": 19436848, "event_date": "2025-10-15 09:30:00", "listing_id": 8842156, "price_qualifier": "guide_price", "price": 685000, "listing_condition": "resale", "key_features": "Period conversion, high ceilings, bay windows, share of freehold, close to Hampstead Heath", "brand_name": "Hampstead Residential", "branch_name": "Hampstead", "first_listed_price": 725000, "recent_reduced_price": 685000, "last_sold_date": "2006-12-01", "last_sold_price": 528250, "listing_type_id": 1, "deposit": "", "letting_type": "Sale", "property_type": "house", "built_form": "terraced", "num_floorPlans": "1", "num_images": "12", "num_videos": "1", "isPremium": "true", "num_beds": 2, "discount_property": 0, "shared_ownership": 0, "HMO": 0, "retirement_property": 0, "auction_property": 0, "probate_property": 0, "chain_free_property": 1, "investment_property": 0, "conservatory": "0", "front_image_url": "https://media.rightmove.co.uk/12345/67890_1.jpg", "listing_status": "Reduced", "listing_type": "Sale", "building_number": "14", "building_name": "", "sub_building_name": "Flat 2", "town": "LONDON", "uprn": "10091866843", "thoroughfare": "BELSIZE PARK", "poan": "14", "soan": "FLAT 2", "lat": 51.5590384, "lng": -0.1775866, "postcode": "NW3 1AA", "listed_date": "2025-09-01 10:00:00", "resident_count": 2, "email_count": 1, "mobile_count": 2, "landline_count": 1 }

Get Sold Properties

GET

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

/market-activity/get-sold-properties

Retrieve sold property records by outward code or full postcode.

Get Sold Properties › query Parameters

first_postcode

postcode

limit

integer · min: 1 · max: 100

Default: 100

page

integer · min: 0

Default: 0

Get Sold Properties › 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 Sold Properties › Responses

Sold property records for a postcode area

Output schema for get_sold_properties endpoint (documentation only). Do NOT use as response_model — return plain dicts from endpoints.

property_id

integer · required

Internal id allocated to a property.

Date the event took place.

Sold price of the listing.

Get Property History

GET

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

/market-activity/get-property-history

Retrieve full event history for a property by property_id.

Get Property History › query Parameters

property_id

integer · required

Get Property History › 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 Property History › Responses

Property event history including sales, listings, and status changes

Output schema for get_property_history endpoint (documentation only). Do NOT use as response_model — return plain dicts from endpoints.

property_id

integer · required

Internal id allocated to a property.

The asking price for sale or rent if there is a recorded event of a listing.

Date the event took place.

The current status of the property such as Reduced, Withdrawn, Sold if there is a recorded event of a listing.

The Brand Name of the agent associated with the event, e.g. 'LandRegistry'.

An internal ID allocated to a agent brand associated with an event, e.g. 'lr01'.

URL link to the property listing on the source portal (Rightmove or Zoopla).

The listing identifier from the source portal.

The portal source code, e.g. 'RMP' for Rightmove.