Main Menu

Press Enter to search or Esc to close

FW Real Estate FW Real Estate – Documentation

MLS Grid Connector

FW Real Estate tutorial for Joomla!

The FWRE MLS Grid Connector addon connects FW Real Estate to MLS Grid — a RESO Web API aggregator covering 200+ US MLS boards. Instead of negotiating a separate data agreement with each board, you authenticate once with your MLS Grid OAuth credentials and the connector imports and syncs listings automatically on a cron schedule.

What MLS Grid Connector Adds

  • OAuth 2.0 authentication: Secure token-based access using your MLS Grid client ID and secret — no legacy FTP or RETS login URLs.
  • 200+ MLS boards: Access any board available under your MLS Grid subscription through a single plugin configuration.
  • RESO auto-mapping: Discover available fields from the metadata endpoint and map them to FW Real Estate property fields with one click.
  • Multi-class import: Import Residential, Commercial, Land, and other property classes — each processed as a separate pass.
  • Incremental sync: Each cron run fetches only records changed since the last import, keeping your site current with minimal API usage.
  • Auto-cleanup: Sold, expired, and withdrawn listings are automatically unpublished or deleted on each sync.

Plugin Parameters

After installing the plugin, go to Extensions → Plugins, search for FW Real Estate — MLS Grid, and open its parameters.

ParameterDescription
Client IDYour MLS Grid OAuth client ID, obtained from the MLS Grid developer portal.
Client SecretYour MLS Grid OAuth client secret. Stored encrypted and never exposed on the frontend.
Resource classesSelect which property classes to import (Residential, Commercial, Land, etc.). Each class is imported in a separate pass.
Removed listing actionChoose whether to unpublish or delete listings that are no longer returned by the feed.
Batch sizeNumber of records to process per cron invocation. Default 500. Reduce if your server has memory limits.

Getting MLS Grid API Access

Apply at mlsgrid.com. Access requires MLS membership and approval from your MLS board. Once approved, you receive an OAuth client ID and client secret. Approval typically takes 1–3 weeks depending on your board.

Field Mapping

After entering credentials, open the plugin's Auto-Mapping tab. The connector queries the MLS Grid metadata endpoint and lists all available RESO Data Dictionary fields. Click Suggest Mapping to automatically match standard field names (ListPrice, BedroomsTotal, BathroomsTotal, etc.) to the corresponding FW Real Estate property fields. Review and save the mapping before running the first import.

Running the First Import

  1. Save the plugin parameters with valid credentials.
  2. Open the plugin's Import tab and click Run Manual Import to verify listings are retrieved correctly.
  3. Check the import log for any field mapping errors or authentication issues.
  4. Once satisfied, configure a cron job to call the import endpoint on your preferred schedule (30–60 minutes recommended).

Important Notes

  • Available MLS boards depend on your MLS Grid subscription and MLS membership. Log in to the MLS Grid portal to confirm which boards are accessible.
  • MLS Grid requires RESO Web API compliance from all connected boards — this connector is not compatible with RETS-only boards.
  • Property photos are downloaded and stored locally during import. Ensure your server has sufficient disk space before running a large initial import.

To install this addon, open the Add-ons panel inside FW Real Estate. See Getting Started → Add-ons for details on paid addons and site verification.


Was this article helpful?
Previous
Watermark
Next
Trestle Connector
  • Client Login

    Restore password
  • New Registration

or
Make sure @fastw3b.com email domain is white-listed in your email client to restore password, verify registration, get order confirmations, etc.