Skip to main content

Add the Similar Listings Macro to IDX Details Page Custom Templates

Overview

IDX Broker includes a Similar Properties widget that can display related listings on Details pages when enabled in Details Preferences.

If a partner custom template was published before this feature was added, the template may need to be updated manually by adding the Similar Listings macro.

How Similar Listings Are Matched

The widget displays listings similar to the property currently being viewed based on:

  • Price within 20% of the current listing
  • Same postal code
  • Same status
  • Same IDX ID / MLS
  • Same property type

For rental/lease or sold listings, the related price fields are used.

If no listings match the criteria, the widget displays:

No listings found

Requirements

  • Details Preferences feature enabled:
    • Display Similar Listings on Details Page
  • Access to the partner custom details template
  • Ability to edit Twig template files

Template Macro

Add the following macro to the Details page template:

{# Similar Listings #}
{% if clientRules.displaySimilarListingsOnDetailsPage == 'y' %}
    {% include 'similarProperties-1.000.twig' %}
{% endif %}

Recommended Placement

By default, this macro should be placed after the MLS disclaimer/courtesy section:

{# disclaimer / courtesy / css selector #}
{% if missingProperty == false and propArchived == false %}
    {% include 'singleMlsDisclaimers-1.000.twig' %}
{% endif %}

And before the Details contact form:

{% if contactOnDetails %}
    <div id="IDX-detailsContactForm">
        {% include 'mobileFirstContactComp-1.001.twig' %}
    </div>
{% endif %}

Important Notes

  • New partner custom templates should include this functionality by default
  • Older published custom templates may need to be updated manually
  • The widget only displays if the client has enabled the feature in Details Preferences
  • If there are no matching listings, “No listings found” will display

Troubleshooting

Similar listings are not showing

  • Confirm the feature is enabled in Details Preferences
  • Verify the macro was added to the active custom template
  • Confirm the listing has comparable properties matching the criteria

Widget displays “No listings found”

  • This means no listings matched the required criteria
  • Check whether listings share the same postal code, status, MLS, and property type

Template error appears

  • Confirm the included Twig file name is correct:
    • similarProperties-1.000.twig

🤖 Zendesk AI / Answer Bot Intents

Intent: Add Similar Listings to custom template

User might ask:

  • “How do I add Similar Listings to my custom template?”
  • “Why doesn’t my custom details template show similar properties?”

Answer:
If the custom details template was published before the Similar Listings feature was added, add the Similar Listings Twig macro to the template and make sure the feature is enabled in Details Preferences.

Intent: Similar Listings not showing

User might ask:

  • “Why aren’t similar listings showing on details pages?”

Answer:
Similar Listings only display when the feature is enabled and matching listings exist. The widget matches by price range, postal code, status, MLS, and property type.

Intent: Similar Listings criteria

User might ask:

  • “How are similar listings chosen?”

Answer:
Similar listings are matched using a 20% price range, same postal code, same status, same IDX ID/MLS, and same property type.

 
 

Related articles

Powered by Zendesk