Skip to main content

Integrate Search Embed

This page allows you to integrate a previously created saved search into a website or application. The available options depend on the type of site you have configured.

View Search Embeds Page and click the Admin dropdown menu (represented by a gear icon) next to a saved search, then select Integrate Search Embed to view this page.

Saved Search Information​

At the top of the page, you will find information about the specific saved search you are integrating.

  • Name: The name you assigned to the saved search.
  • Saved Search: A human-readable summary of the search criteria, such as property type, location, and price range.

This section provides the links and code snippets you need to integrate the search embed. All links are pre-populated with the offset and limit parameters. You can adjust these values to control the number of results returned.

This is a direct URL to a web page that displays the search results.

  • Use: Embed this link in a button or a navigation menu item to direct visitors to the search results page.
  • Format: [your-site-domain]/search-embed/[saved-search-id]?offset=0&limit=10

Wordpress Shortcode​

If your site uses the PeakIDX Wordpress plugin, you can use a shortcode to embed the search results directly within a Wordpress post or page.

  • Use: Copy and paste this shortcode into the Wordpress editor.
  • Format: [peakidx-react-component name="listings" type="listings" search-results-api-url="/search-results-api/[saved-search-id]?offset=0&limit=12"]

JSON API Call​

This is a URL for programmatically fetching search results as a JSON object. This is useful for developers who want to build custom front-end applications.

  • Use: Make an HTTP request to this URL from your application.
  • Validation: You must pass the Origin HTTP header with your site's domain to validate the request.
  • Format: [your-site-domain]/search-results-api/[saved-search-id]?offset=0&limit=10