Skip to main content

How to Integrate HoodQ on IDX Details Pages

Updated

Overview

For Canadian listings, GreatSchools is not supported on IDX details pages.

As an alternative, you can use HoodQ, a free tool that provides neighborhood insights such as schools, transit, and amenities.

HoodQ can be embedded directly into IDX listing details pages using a simple script.

Requirements

  • A HoodQ account
  • HoodQ API key
  • Access to your IDX Broker site (for adding scripts)
  • Basic knowledge of JavaScript (optional for customization)

Setup Instructions

Step 1: Get a HoodQ API Key

  1. Sign up at HoodQ
  2. Retrieve your API key from your account

Step 2: Add HoodQ Script to Details Pages

Add the following script to your IDX details page implementation:

<script src="https://gist.github.com/cosmicwomp/41d467a258a32b09e0f0467b193ef36f.js"></script>
  • Replace the placeholder in the script with your client’s HoodQ API key

Step 3: (Optional) Reposition the Widget

If you want to move the HoodQ widget to a different location on the page, you can use this script:

<script src="https://gist.github.com/cosmicwomp/cc5e8c56d3949589b5003aceae2d72d8.js"></script>

This allows you to reposition the widget using JavaScript.

How It Works

  • The script injects the HoodQ widget into IDX listing pages
  • It automatically pulls location-based data for the property
  • Displays neighborhood insights relevant to the listing

Important Notes

  • HoodQ is primarily used for Canadian markets
  • Requires a valid API key to function
  • Widget placement may require custom JavaScript adjustments
  • This is a third-party integration (not native to IDX Broker)

Troubleshooting

Widget not showing

  • Confirm API key is correct
  • Check browser console for JavaScript errors
  • Ensure script is properly added to the page

Widget in wrong location

  • Use the repositioning script
  • Adjust selectors in custom JavaScript if needed

No data displaying

  • Confirm listing location is supported by HoodQ

Support

If you run into issues, contact:
developers@idxbroker.com

🤖 Zendesk AI / Answer Bot Intents

Intent: GreatSchools not working in Canada

User might ask:

  • “Why doesn’t GreatSchools show on my listings?”

Answer:
GreatSchools isn’t supported in Canada. You can use HoodQ as an alternative to display neighborhood and school data on listing pages.

Intent: Add HoodQ to IDX

User might ask:

  • “How do I add HoodQ to my listings?”

Answer:
Sign up for HoodQ, get your API key, and add the provided script to your IDX details pages. You can also reposition the widget using JavaScript.

Intent: HoodQ widget not working

User might ask:

  • “Why isn’t HoodQ showing up?”

Answer:
Check that your API key is correct, ensure the script is properly added, and review the browser console for errors.

Intent: Move HoodQ widget

User might ask:

  • “Can I change where HoodQ appears?”

Answer:
Yes, you can reposition the widget using JavaScript to move it anywhere on the details page.

Powered by Zendesk