Developer Documentation
Platform Overview
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: 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 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: Geometries Portals Preferences 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
Supporting Documentation
Terms of Use

Accessing FloPlan Data Using RETS

FloPlan data can be accessed using RETS in the manner listed below. The floor plan itself will be represented exclusivelyas a URL.

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.


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 GetObject Response

All applicable FloPlan image URL's will be automatically appended to a listing's GetObject response when using the Location=1 parameter and represented identically to a "normal" photo record. If your data pull processes are already retrieving high resolution listing photo URLs from the Flexmls RETS server, FloPlan records will simply start flowing as part of that same process. No changes necessary.

More information on the RETS Location=1 parameter can be found here


If you attempt to retrieve a FloPlan record in binary format by omitting the Location parameter from your GetObject request or setting Location=0 you'll receive a not found error message, similar to what you'd experience when encountering a private photo. To retrieve any FloPlan records you'll need to include the Location=1 parameter in your GetObject request, which instructs the RETS server to return a hot-linkable URL to the image.