FloPlan API Overview

If you are not authorized to retrieve FloPlan data directly via your RETS and/or Spark API listing feeds or prefer to access a standalone API exclusively for FloPlan data, you can use the RESTful FloPlan API outlined below to retrieve FloPlan data. Built on the RESO Web API standard, FBS is committed to providing a standardized interface across any MLS you need to access FloPlan data within.

If you need assistance on the standalone FloPlan API please reach out to our support team and we'd be happy to help.

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. If you'd prefer to access FloPlan data directly within your existing MLS data feed(s) visit our overview page for details.

Approval
Server Endpoint
Authentication
Making Requests
Response Description
Replication Warning

1. Approval

Access to the standalone FloPlan API would need to be requested by following the approvals process outlined on this page.

2. Server Endpoint

The standalone FloPlan API endpoint is at:

https://api.floplan.io/Reso

3. Authentication

All developers will be issued non-expiring OAuth 2 access tokens that may be used to access the FloPlan API directly. All requests using such a token must be made using HTTPS.

Important!

Never provide your access_token to a web browser or other end-user agent. Instead, maintain a separate session and persist this data in a location accessible only by your application (e.g. do not store the access_token in a cookie). Contact api-support@floplan.io for further guidance.

To request data from the api you will need to provide two headers. The Authorization header and the Accept header. You will typically want an Accept header of application/json but, if you are accessing the metadata document of a RESO metadata document you will need to use application/xml. For the Authorization header you will use "Bearer YOUR_ACCESS_TOKEN".

Additional information and cURL examples related to authentication can be found here.

Example /$metadata Retrieval Headers

Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/xml

Example /Media Retrieval Headers

Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

4. Making Requests

Make a GET request to one of the supported services to begin retrieving data from the FloPlan API. Note that the $filter parameter is required for all requests to the /Media endpoint. If the $filter parameter is omitted from your requests or the $filter value is null the Floplan API will return an error code and your request will be unsuccessful. A full description of searchable fields can be found under the supported services documentation. Example filters and requests can be found in the examples documentation.

https://api.floplan.io/Reso/Media?$filter=OriginatingSystemResourceRecordKey eq 'LISTINGKEY_HERE' and OriginatingSystemResourceRecordSystemID eq 'RESO_OUID_HERE'

Important!

Data replication is not allowed when using the FloPlan API. See the Replication Warning below for more information.

5. Response Description

All /Media endpoint responses will be in JSON format. All /$metadata responses will be in XML format. An example /Media and /$metadata payload can be found in the supported services documentation.

6. Replication

Data replication is strictly disallowed when using the FloPlan API. All data must be retrieved live from the API and cannot be stored locally. Stated another way, any time a user views a FloPlan floor plan on your website you must make a call to the FloPlan API to retrieve that data.