Show Property List
property-list-widgetParameters (1 required, 18 optional)
locationstringMandatory location for the area of the search within the UK. Can be a postcode, region, outcode, or station. The location should be a real UK location. It should not be fictional.
channelstringOptional transaction type for the search. Must be either "BUY" or "RENT". Defaults to "BUY" if not specified.
dontShowarrayOptional list of features the property should not have. Each value must be one of: NEW_HOME,RETIREMENT,SHARED_OWNERSHIP,BUYING_SCHEMES,AFFORDABLE_BUYING_SCHEMES,AUCTION,BUSINESS_FOR_SALE,HOUSE_SHARE,STUDENT,GARDEN,PARKING,PRIVATE_POOL,COMMUNAL_POOL,GOLF,AT_GOLF_COURSE,NEAR_GOLF_COURSE,BEACHFRONT,NEAR_BEACH,SEA_VIEW
includeLetAgreedbooleanOptional boolean to include properties marked as Let Agreed. Defaults to false.
includeSSTCbooleanOptional boolean to include properties marked as Sold Subject to Contract (SSTC). Defaults to false.
isComparisonbooleanOptional boolean indicating if the user asked for property comparison. It must be true if the user states anything about comparing properties, and false otherwise.
letTypestringOptional let type for rental properties. Only applicable when channel is "RENT". Must be one of: "LONG", "SHORT", "STUDENT".
LONGSHORTSTUDENTmaxBathroomsintegerOptional maximum number of bathrooms. Accepts values from 1 to 5.
maxBedroomsintegerOptional maximum number of bedrooms. Accepts values from 0 (studio) to 10.
maxPriceintegerOptional maximum price in GBP (£). Accepts values from £0 to £50,000,000.
minBathroomsintegerOptional minimum number of bathrooms. Accepts values from 1 to 5.
minBedroomsintegerOptional minimum number of bedrooms. Accepts values from 0 (studio) to 10.
minPriceintegerOptional minimum price in GBP (£). Accepts values from £0 to £50,000,000.
mustHavearrayOptional list of features the property must have. Each value must be one of: NEW_HOME,RETIREMENT,SHARED_OWNERSHIP,BUYING_SCHEMES,AFFORDABLE_BUYING_SCHEMES,AUCTION,BUSINESS_FOR_SALE,HOUSE_SHARE,STUDENT,GARDEN,PARKING,PRIVATE_POOL,COMMUNAL_POOL,GOLF,AT_GOLF_COURSE,NEAR_GOLF_COURSE,BEACHFRONT,NEAR_BEACH,SEA_VIEW
propertyTypesarrayOptional list of property types. Each value must be one of: HOUSE, DETACHED, SEMI_DETACHED, TERRACED, FLAT, BUNGALOW, LAND, PARK_HOME, MOBILE_HOME, STUDENT_HALL, SERVICED_OFFICE, BUSINESS_PARK, OFFICE, WORKSHOP, POST_OFFICE, HAIRDRESSER, GARAGE, CONVENIENCE_STORE, SHOP, RETAIL_HIGH_STREET, RETAIL_OUT_OF_TOWN, RETAIL_SHOPPING_CENTRE, RETAIL_RETAIL_PARK, RETAIL_POP_UP, LEISURE_FACILITY, PUB, RESTAURANT, CAFE, HOTEL, TAKEAWAY, BAR_NIGHTCLUB, GUEST_HOUSE, HOSPITALITY, WAREHOUSE, SHOWROOM, STORAGE, LIGHT_INDUSTRIAL, HEAVY_INDUSTRIAL, DISTRIBUTION_WAREHOUSE, TRADE_COUNTER, FACTORY, INDUSTRIAL_PARK, RESIDENTIAL_DEVELOPMENT, INDUSTRIAL_DEVELOPMENT, FARM, MIXED_USE, HEALTHCARE_FACILITY, CHILDCARE_FACILITY, PLACE_OF_WORSHIP, PETROL_STATION, OTHER
radiusnumberOptional search radius, in miles, defining the distance from the specified location. Must be one of the following: 0.25,0.5,1,3,5,10,15,20,30,40. Round to the nearest allowed value if an invalid radius is provided.
sortTypestringSort order (string id). Allowed values: 1=PRICE_ASC, 2=PRICE_DESC, 4=DISTANCE_ASC, 6=ADDED_DATE_DESC, 10=ADDED_DATE_ASC, 13=RELEVANCE_DESC, 14=SIZE_ASC, 15=SIZE_DESC, 18=SCORE_DESC. If omitted, the search API defaults to 18 (relevance/score descending).
12461013141518tagsarrayOptional property features or classifications. Must be one of the following: air conditioning,annexe,arched windows,attic,auction,balcony,barbeque,area,barn,barn conversion,basement,bathtub,bay windows,bifold doors,bike storage,bills included,block of apartments,brick built,built for rent,bungalow,canalside,caravan,carpeted flooring,carport,cash buyer,cctv system,cellar,central location,chain free,character,children play area,cinema room,city centre,cloakroom,close to beach,close to church,close to golf course,close to park,close to schools,close to shops,close to station,close to university,close to woodland,coach house,coastal,communal garden,concierge,conservatory,contemporary style,converted property,corner plot,cottage,countryside views,courtyard,cul de sac,detached,detached bungalow,detached garage,development potential,dining room,dishwasher,dormer,dormer windows,double garage,double glazed windows,downstairs bedroom,dressing room,driveway,duplex,eco friendly,edwardian,electric heating,end of terrace,ensuite,equestrian,exposed beams,exposed brick,farm,farmhouse,fenced,fireplace,first floor,freehold,furnished,games room,garage,garden,garden office,gas central heating,gated access,georgian,grazing land,greenhouse,ground floor,gym,heat pump,high ceilings,hmo,holiday park,home office,hot tub,house,house boat,house share,intercom entry,kitchen island,laminate flooring,land,large garden,leasehold,lift access,listed building,loft,loft conversion,long lease,maisonette,manor,marina,mews,modernised,modern style,mooring,multiple reception rooms,multiple vehicle parking,new build,new homes,no deposit,off street parking,oil central heating,open plan,open plan kitchen,outbuilding,paddock,parking,park home,part exchange,patio,penthouse,period,pet friendly,planning permission,pond,porch,property extension,quiet location,rear extension,refurbished,renovated property,residential area,residential development,retirement home,riverside,river view,roof terrace,rural,sash windows,sauna,scenic views,sea view,semi detached,semi detached bungalow,separate kitchen,separate wc,shared ownership,share of freehold,shed,short term,shower,solar panels,spa facilities,split level,stable,stone built,storage space,student housing,studio,swimming pool,tennis,terraced house,thatched,top floor,townhouse,town centre,underfloor heating,unfurnished,utility room,victorian,village,walk in shower,walk in wardrobe,warehouse,washing machine,waterside living,wet room,wheelchair access,with land,wooden beams,wooden features,wood burner,wood flooring,workshop
tenureTypesarrayOptional list of tenure types for the property. Only applicable when channel is "BUY". Each value must be one of: LEASEHOLD, SHARE_OF_FREEHOLD, FREEHOLD, FEUDAL, COMMONHOLD, NON_TRADITIONAL