Searches the lettings properties a website shows.

Scope: read:lettings-website

The V2 copy of network.api's GET api/lettings-properties. Each result has the same
fields, with the same names, and the parameters are the same apart from these:

  • limit replaces fetch, and the results come in V2's
    { data, pagination } envelope, where total is how many match in all.
  • teamIds replaces teamAPIList: team ids, not other teams' API keys. It
    narrows the search to those teams, and each must be one the key can reach, or the
    request answers 403.
  • Enums are names, as everywhere in V2: webListingStatuses=toLet, and
    letPeriod comes back as a name too.

The key decides what's searched: a team key its team, a client key its client and a network
key its network. Without webListingStatuses, properties to let and let agreed
appear, or to let alone with excludeUnderOffer.

With lat and lng, results are limited to range miles (no limit
without it) and each carries its propertyDistance in miles.

GET /v2/website/lettings/properties?lat=51.5072&lng=-0.1276&range=5
&minBeds=2&maxRent=1800&sortOrder=lowestPrice&limit=12

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
0 to 2147483647
int32
1 to 100
float

The latitude to search from.

float

The longitude to search from.

int32

The search radius from lat and lng, in miles.

TeamIds
array of uuids

Only these teams' properties. Each must be a team the API key can reach, or the request
answers 403.

TeamIds
boolean

Leave out properties let agreed, when webListingStatuses isn't given.

boolean

Only properties set to appear on the website's carousel.

boolean

Only featured properties.

int32

The fewest bedrooms. 0 or 1 means no minimum.

int32

The lowest rent. 0 means no minimum.

int32

The highest rent. 0 means no maximum.

string

A property's reference.

PropertyTypes
array of objects

Only these property types.

PropertyTypes
LetPeriod
array of objects

Only these let periods: long term, short term or either.

LetPeriod
Allowed:
string
enum

One of the predefined groups of property types. Replaces propertyTypes.

Allowed:
WebListingStatuses
array of objects

The website listing statuses to include. To let and let agreed when not given, or to let
alone with excludeUnderOffer.

WebListingStatuses
Allowed:
string
enum

Only properties whose team has this role.

Allowed:
string
enum

The order of the results. Highest rent first by default.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
*/*