SimplyRETS

Overview

SimplyRETS brings your MLS listings into ChatSpark. Visitors describe what they're looking for, your AI agent searches and responds in the same conversation. If you already have a SimplyRETS account, connect your credentials and you are live.

Prerequisites

Before setting up the SimplyRETS integration, you'll need:

• An active SimplyRETS account
• Your SimplyRETS API username
• Your SimplyRETS API password
• Your website URL
• Your listing URL path (the URL structure for listing detail pages on your site)
• Your Vendor ID, if your account has more than one MLS board connected

You can find your API credentials in the SimplyRETS dashboard under Account Settings. If you are on a trial, the default test credentials are simplyrets and simplyrets.

Setup Instructions

Step 1: Gather Your Credentials

1. Log in to your SimplyRETS dashboard at simplyrets.com/account
2. Under Account Settings, locate your API Username and API Password
3. Copy both values. Keep your password secure and do not share it publicly.

Step 2: Enable in ChatSpark

1. In ChatSpark, go to AI Actions
2. Find SimplyRETS in the Library and click Enable
3. Select the AI Agent(s) that should have access
4. Enter your API Username and API Password
5. If your account has multiple MLS boards, enter your Vendor ID
6. Enter your Website URL and Listing URL Path
7. Click Test in Sandbox & Save

Configuration Fields

Search Capabilities

Visitors can search by any combination of the following:

• Location: City, state, ZIP code, address
• Price range: Min/max price, “under $500k”
• Bedrooms: Number of beds, “at least 3 bedrooms”
• Bathrooms: Number of baths
• Property type: Residential, condominium, townhouse, and more
• Square footage: Min/max interior size
• Status: Active, Pending, Closed

Example Queries

• “Show me 3-bedroom homes in Austin under $600,000”
• “Find condos near downtown with at least 2 baths”
• “What homes are available in Round Rock with a garage?”
• “Search for properties between $400k and $700k in Cedar Park”

Each result displays as a property card with a photo, price, address, beds/baths/sqft, and a link to the full listing.

Testing Your Integration

Open your AI Agent widget and ask: “Show me homes for sale in [your area].” You should see matching listings returned. If you are using SimplyRETS test credentials, results will include sample listings that SimplyRETS provides for development and testing.

Adding Ask AI Buttons to Listings

Add a button to any listing page and turn property views into conversations. When a visitor clicks, ChatSpark opens with that address pre-filled, your AI agent pulls the listing details from SimplyRETS, and can capture their contact details as the conversation continues.

Add the cs-trigger-agent class and a data-triggerattribute to any HTML element on your listing pages:

<button class="cs-trigger-agent" data-trigger="Tell me about 456 Oak Avenue, Austin, TX 78702">
  Ask AI
</button>

Use the full street address as it appears in your MLS data. See AI Agent Triggers for full setup options.

Multiple MLS Boards

If your SimplyRETS account is connected to more than one MLS board, the API requires a Vendor ID to know which board to search. Without it, requests may return results from the wrong board or fail.

To find your Vendor IDs, log in to your SimplyRETS account panel or run an OPTIONS request against the API:

curl -XOPTIONS -u your_username:your_password https://api.simplyrets.com/properties

The response includes a list of available vendors. Enter the one that matches the MLS board you want this AI Action to search.

Troubleshooting

Invalid credentials error

If credentials fail during testing:

• Wrong username or password: Double-check both values from your SimplyRETS dashboard
• Account inactive: Confirm your SimplyRETS account is active and in good standing
• Typo in fields: Credentials are case-sensitive

Results from the wrong MLS board

If you have more than one MLS board on your SimplyRETS account and results look incorrect, add your Vendor ID to the AI Action configuration to scope searches to the right board.

No results returned

If searches return no results:

• Confirm your SimplyRETS account has access to the MLS you are searching
• If you have multiple boards, make sure your Vendor ID is set correctly
• Try a broader search with fewer filters
• Check that the city or area name is spelled correctly

Listing links are not working

Make sure both your Website URL and Listing URL Path are set in the AI Action configuration. The Listing URL Path must include the {mls_id} variable to generate valid links.