Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates Flexmls: Mapping Layers Flexmls: Mapping Shapegen IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: Floor Plans Listings: FloPlans Listings: Historical Listings: History Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Accessing FloPlan Data Using Spark

FloPlan data can be accessed using Spark API in one of the three manners listed below. The floor plan itself will be represented as a URL, similar to how Spark manages listing photos.

Any time the addition, change, or deletion of a FloPlan record impacts a listing, that listing's PhotosChangeTimestamp, ModificationTimestamp, and PhotosCount fields will be updated appropriately. Additionally, there is a new FloorPlansChangeTimestamp field that indicates the DateTime of the last update to a listing's floor plans data.


Important!

As of August 5th, 2021 FBS is releasing a change that will allow developers to retrieve FloPlan data as part of the listing data payload presented in their RETS, Spark API, and RESO Web API feeds. For a full list of options regarding FloPlan data retrieval visit our overview page.


1. Automatically Included in Photos Expansion and Service

All applicable FloPlan records will be automatically appended to the end of the photo roll and represented near identically to a "normal" photo record. If your data pull processes are already retrieving photos from the Spark API, all applicable FloPlan records will simply start flowing as part of that same process. No changes necessary. Each of these FloPlan records will have a Caption of "Floor Plan".

For more information on retrieving Photo data via the Spark API see the documentation links below:



2. /listings/<Listing.Id>/floplans Service

See the service documentation below for details.



3. /listings/<Listing.Id>/floorplans Service

See the service documentation below for details. This service differs from the /listings/<Listing.Id>/floplans service in that it can potentially contain floor plans from other sources. It is not technically limited to just FloPlan data.