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: 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: 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

Privileged API Keys Only

Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.

Flexmls: Mapping: Layers

The Flexmls: Mapping: Layers service provides the tile layers available on the flexmls map server.

 
  1. Supported Roles
  2. Available Services
    1. All Layers
    2. Individual Layers
  3. Layers Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes No

More information about roles may be found here.

 

Available Services

All Layers

/<API Version>/flexmls/mapping/layers

HTTP Method Description Conditional Notes
GET Returns all layers available to the user. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

Parameter Required Notes
Standard search and paging syntax No
 
 

GET Response

{
    "D": {
        "Results": [
            {
                "Id": "2021010511111111111000000",
                "ResourceUri": "/v1/flexmls/mapping/layers/2021010511111111111000000",
                "MlsId": "20210105000000000000000000",
                "LayerName": "counties",
                "Description": "Counties",
                "Legends": [],
                "DataSource": nil
            },
            {
                "Id": "2021010522222222222000000",
                "ResourceUri": "/v1/flexmls/mapping/layers/2021010522222222222000000",
                "MlsId": "20000426143505724628000000",
                "LayerName": "us_flood_zones",
                "Description": "FEMA Flood Zones",
                "Legends": [
                    {"Color": "FA928F", "Description": "A: Detailed analysis not performed. 26% chance over 30yr mortgage"},
                    {"Color": "C7AB8F", "Description": "AE: Base elevations are provided. 26% chance over 30yr mortgage"},
                    {"Color": "FABFE7", "Description": "AH: Pond flood hazard"},
                    {"Color": "C2928F", "Description": "AO: River or stream flood hazard"},
                    {"Color": "BFFFCF", "Description": "V: Flooding with wave hazard. Base elevations not provided"},
                    {"Color": "7EE3E3", "Description": "VE: Flooding with wave hazard"}
                ],
                "DataSource": {
                    "Url": "https://maps.whatever.com",
                    "Label": "FEMA Flood Zones 2013"
                }
            }
        ],
        "Success": true
    }
}
 
 

Individual Layers

/<API Version>/flexmls/mapping/layers/<Layer.Id>

HTTP Method Description Conditional Notes
GET Returns a specified Layer record No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

{
    "D": {
        "Results": [
            {
                "Id": "2021010522222222222000000",
                "ResourceUri": "/v1/flexmls/mapping/layers/2021010522222222222000000",
                "MlsId": "20000426143505724628000000",
                "LayerName": "us_flood_zones",
                "Description": "FEMA Flood Zones",
                "Legends": [
                    {"Color": "FA928F", "Description": "A: Detailed analysis not performed. 26% chance over 30yr mortgage"},
                    {"Color": "C7AB8F", "Description": "AE: Base elevations are provided. 26% chance over 30yr mortgage"},
                    {"Color": "FABFE7", "Description": "AH: Pond flood hazard"},
                    {"Color": "C2928F", "Description": "AO: River or stream flood hazard"},
                    {"Color": "BFFFCF", "Description": "V: Flooding with wave hazard. Base elevations not provided"},
                    {"Color": "7EE3E3", "Description": "VE: Flooding with wave hazard"}
                ],
                "DataSource": {
                    "Url": "https://maps.whatever.com",
                    "Label": "FEMA Flood Zones 2013"
                }
            }
        ],
        "Success": true
    }
}
 
 

Layers Description

Attribute Data Type Description
Id Character The unique id for the Layer.
ResourceUri Character The URI to the Layer.
MlsId Character The ID for the MLS to which the Layer belongs.
LayerName Character The name of the Layer on the map server.
Description Character The human-readable name for the Layer.
Legends Array of JSON Objects Additional information associated with shapes within the layer, if present.
Legends[n].Description Character The name associated with a shape within the Layer, if present
Legends[n].Color Character The color associated with the named shape within the Layer, if present.
DataSource JSON Object A URL and label to build a link to display which provides further information on the data presented in the layer.
DataSource.Url Character URL for further information on data presented in the layer.
DataSource.Label Character Label associated with URL.
 

Expansions

None.

 

API Explorer

Interact with this service using the API Explorer.