Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

How do I use the V4 Advertising API to retrieve property listings?

The V4 Advertising API provides all the data needed to list lettings and sales properties on marketing websites, including photos, property details, rooms, facilities, and EPC documents. All endpoints are available at https://live-api.letmc.com/v4/advertising/.

Retrieving lettings properties

Follow this workflow to build a complete lettings property listing:

  1. Get branches — GET /v4/advertising/{shortName}/company/branches/{offset}/{count} Retrieve all company branches to loop through for property listings.
  2. Get advertised lettings — GET /v4/advertising/{shortName}/lettings/advertised/{offset}/{count} Returns summary information for all marketed tenancies. Many fields will be null at this stage — this is expected.
  3. Get detailed tenancy information — GET /v4/advertising/{shortName}/lettings/advertised/{tenancyID} For each tenancy from step 2, retrieve full tenancy details including the property ID.
  4. Get property details — GET /v4/advertising/{shortName}/lettings/properties/{propertyID} Use the property ID from step 3 to retrieve comprehensive property information.

Supplementary lettings endpoints:

  • Rooms: /lettings/properties/{propertyID}/rooms/{offset}/{count}
  • Facilities: /lettings/properties/{propertyID}/facilities/{offset}/{count}
  • Portal media: /lettings/{propertyID}/portalmedia/{offset}/{count}
  • Photos: /lettings/properties/{propertyID}/photos/{offset}/{count} (each photo must be downloaded separately)

Retrieving sales properties

  1. Get advertised sales — GET /v4/advertising/{shortName}/sales/advertised/{offset}/{count} Returns summary information for marketed sales properties. Supports extensive filtering by price range, bedroom count, property features, and more.
  2. Get sales instruction details — GET /v4/advertising/{shortName}/sales/salesinstructions/{salesInstructionID} Retrieve full details for a specific sales instruction.

Supplementary sales endpoints:

  • Photos: /sales/salesinstructions/{salesInstructionID}/photos/{offset}/{count}
  • Rooms: /sales/salesinstructions/{salesInstructionID}/rooms/{offset}/{count}
  • Features: /sales/salesinstructions/{salesInstructionID}/features/{offset}/{count}
  • Floor plans: /sales/salesinstructions/{salesInstructionID}/floorplans/{offset}/{count}
  • Portal media: /sales/{salesInstructionID}/portalmedia/{offset}/{count}
  • Feature types: /sales/salesfeaturetypes/{offset}/{count}

Downloading assets

  • Photos: GET /v4/advertising/{shortName}/download/{photoID} — returns the image file
  • EPC graphs: GET /v4/advertising/{shortName}/download/{OID}/epc/{graphType} — for lettings use the property OID; for sales use the sales instruction OID

Property brochures

The brochure endpoint is no longer active. Use these URL patterns instead:

  • Lettings: property.agentos.com/{shortName}/{tenancyGlobalReference}
  • Sales: property.agentos.com/{shortName}/{salesGlobalReference}

Sales filtering parameters

The sales advertised endpoint supports the following filters: onlyDevelopment, onlyInvestments, minimumPrice, maximumPrice, minimumBeds, minimumBathrooms, minimumEnsuites, minimumReception, state.

Rate limiting: Standard 50 requests per minute applies.

Test with Swagger: Select "V4.Advertising" from the tier dropdown at https://live-api.letmc.com/swagger/ui/index.