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 Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates 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: Hot Sheet Parameters 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: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata 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
Terms of Use

Property Types

Not all listing data is suitable for display.
When using the Listings Service, you must consult the corresponding meta data services (e.g. Property Types and Standard Fields) for the PropertyType standard field and any other field where the HasList is true in the meta data.

See an example here.

 

The Property Types service returns a list of possible listing property types for the current user’s MLS.

  1. Supported Roles
  2. Available Services
    1. Active Property Types
    2. All Property Types
  3. Response 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

Active Property Types

/<API Version>/propertytypes
/<API Version>/mls/<MlsId>/propertytypes

HTTP Method Description Notes
GET Returns a list of all property types for the specified MLS
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

Parameter Description Required
_mls A comma-separated list of MLS IDs the property types should be common across No

GET Response

Example:

{
    "D": {
        "Success": true,
        "Results": [
            {
                "Enabled": true,
                "MlsName": "Residential",
                "MlsCode": "A",
                "PropertyClass": "Residential",
                "RentalCalendar": false,
                "BrokerTours": true
            },
            {
                "Enabled": true,
                "MlsName": "Multi Family",
                "MlsCode": "B",
                "PropertyClass": "Residential",
                "RentalCalendar": false,
                "BrokerTours": false
            },
            {
                "Enabled": true,
                "MlsName": "Land",
                "MlsCode": "C",
                "PropertyClass": "Land",
                "RentalCalendar": false,
                "BrokerTours": false
            },
            {
                "Enabled": true,
                "MlsName": "Commercial",
                "MlsCode": "D",
                "PropertyClass": "Commercial",
                "RentalCalendar": false,
                "BrokerTours": false
            },
            {
                "Enabled": true,
                "MlsName": "Rental",
                "MlsCode": "F",
                "PropertyClass": "Rental",
                "RentalCalendar": true,
                "BrokerTours": false
            }
        ]
    }
}
 

All Property Types

/<API Version>/propertytypes/all

HTTP Method Description Conditional Notes
GET This service will return all Property Types, both enabled and disabled. 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
_mls No A comma-separated list of MLS IDs the property types should be common across
 
 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "Enabled": true,
                "MlsName": "Residential",
                "MlsCode": "A",
                "PropertyClass": "Residential",
                "RentalCalendar": false,
                "BrokerTours": true
            },
            {
                "Enabled": true,
                "MlsName": "Multi Family",
                "MlsCode": "B",
                "PropertyClass": "Residential",
                "RentalCalendar": false,
                "BrokerTours": false
            },
            {
                "Enabled": true,
                "MlsName": "Land",
                "MlsCode": "C",
                "PropertyClass": "Land",
                "RentalCalendar": false,
                "BrokerTours": false
            },
            {
                "Enabled": true,
                "MlsName": "Commercial",
                "MlsCode": "D",
                "PropertyClass": "Commercial",
                "RentalCalendar": false,
                "BrokerTours": false
            },
            {
                "Enabled": false,
                "MlsName": "Farm (Inactive)",
                "MlsCode": "E",
                "PropertyClass": "Farm",
                "RentalCalendar": false,
                "BrokerTours": false
            },
            {
                "Enabled": true,
                "MlsName": "Rental",
                "MlsCode": "F",
                "PropertyClass": "Rental",
                "RentalCalendar": true,
                "BrokerTours": false
            }
        ]
    }
}
 
 

Property Types Description

Attribute Data Type Description
BrokerTours Boolean true if the Broker Tours listings subservice is available for this property type.
Enabled Boolean true for an active property type.
MlsCode Character The code representing the property type, used for searching.
MlsName Character The property type label as chosen by the MLS.
PropertyClass Character The PropertyClass Standard Field item the property type is classified as. Particularly useful in cross-MLS searches where the MlsName and MlsCode may not match.
RentalCalendar Boolean true if the Rental Calendar listings subservice is available for this property type.
 

Expansions

None.

 

API Explorer

Interact with this service using the API Explorer.