FW Real Estate – Documentation
Spark API Connector
The FWRE Spark API Connector addon connects FW Real Estate to Spark API by FBS Data Systems — the RESO Web API platform powering MLS boards that run FBS Flex MLS software. It delivers standardized OData v4 property data with RESO Data Dictionary field names, paginated batch retrieval for large catalogs, and automatic listing photo downloads.
What Spark API Connector Adds
- FBS board access: Connect to any MLS board running FBS Flex MLS that participates in Spark API.
- Paginated batch import: Processes one OData page per cron run and resumes automatically — no server timeouts regardless of catalog size.
- Automatic photo downloads: Listing photos are downloaded and stored locally during import, with automatic resizing for your gallery settings.
- RESO auto-mapping: One-click field mapping using standard RESO Data Dictionary field names.
- Large catalog support: Per-batch cron design handles catalogs of tens of thousands of listings on standard hosting.
- Auto-cleanup: Expired and sold listings are automatically removed from your site on each sync.
Plugin Parameters
After installing the plugin, go to Extensions → Plugins, search for FW Real Estate — Spark API, and open its parameters.
| Parameter | Description |
|---|---|
| API Key | Your Spark API client key, provided by your MLS board or FBS Data Systems support. |
| API Secret | Your Spark API client secret. Stored encrypted. |
| Page size | Number of records per OData page (typically 200–500). Each cron invocation processes one page. |
| Photo download | Enable to download listing photos locally during import. Disable to skip photos and speed up initial import. |
| Removed listing action | Choose whether to unpublish or delete listings no longer in the feed. |
Getting Spark API Credentials
Contact your MLS board or FBS Data Systems support. If your MLS runs on FBS Flex MLS, it participates in Spark API. Your board will provide a client key and client secret after verifying your MLS membership.
How Paginated Import Works
The connector fetches one OData page per cron invocation and stores its progress. The next cron run automatically continues from where the previous one stopped. This design is intentional — it prevents PHP memory exhaustion and request timeouts on large boards, allowing a full import of tens of thousands of listings without any special server configuration. Once all pages are processed, the connector switches to incremental mode and fetches only changed records on subsequent runs.
Photo Storage
When photo download is enabled, the connector fetches all photos for each listing and stores them in your FW Real Estate media folder. Photos are resized to match your configured gallery dimensions. Locally stored photos load faster for your visitors and eliminate a dependency on the MLS CDN for image delivery.
Important Notes
- Spark API is exclusive to FBS-powered MLS boards. If your MLS uses a different platform, use the MLS Grid or Trestle connectors instead.
- The initial full import runs across multiple cron invocations. Do not expect all listings immediately after enabling the plugin — allow the cron to complete all pages first.
- Ensure your server has sufficient disk space before enabling photo downloads on a large catalog.
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.
