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: 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: Required Documents 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: 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: Required Documents 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: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Overlays Overlays: Geometries Portals Portals: Listing Categories Portals: Metadata 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
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Units Metadata

The Units Metadata service describes the available fields for listing units data.

 
  1. Supported Roles
  2. Available Services
    1. All Units
    2. Individual Room Field
  3. Units Metadata Description
  4. Expansions
 

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 Units

/<API Version>/units
/<API Version>/mls/<MlsId>/units

HTTP Method Description Conditional Notes
GET 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": {
        "Success": true,
        "Results": [
          {
            "UnitsTotal": {
              "Type": "Character",
              "ResourceUri": "/v1/unitfields/UnitsTotal",
              "Label": "# of Units",
              "HasList": false,
              "Searchable": false,
              "MlsVisible": [
                "B"
              ]
            },
            "unit_nbr": {
              "Type": "Character",
              "ResourceUri": "/v1/unitfields/unit_nbr",
              "Label": "Unit Type",
              "HasList": true,
              "Searchable": false,
              "MlsVisible": [
                "B"
              ]
            },
            "ActualRent": {
              "Type": "Character",
              "ResourceUri": "/v1/unitfields/ActualRent",
              "Label": "Rent",
              "HasList": false,
              "Searchable": false,
              "MlsVisible": [
                "B"
              ]
            },
            "sqft": {
              "Type": "Character",
              "ResourceUri": "/v1/unitfields/sqft",
              "Label": "SqFt",
              "HasList": true,
              "Searchable": false,
              "MlsVisible": [
                "B"
              ]
            },
            "BedsTotal": {
              "Type": "Character",
              "ResourceUri": "/v1/unitfields/BedsTotal",
              "Label": "Bedrooms",
              "HasList": false,
              "Searchable": false,
              "MlsVisible": [
                "B"
              ]
            },
            "BathsTotal": {
              "Type": "Character",
              "ResourceUri": "/v1/unitfields/BathsTotal",
              "Label": "Bath",
              "HasList": true,
              "Searchable": false,
              "MlsVisible": [
                "B"
              ]
            }
          }
        ],
    }
}
 
 

Available Services

Individual Room Field

/<API Version>/units/<Room.Field>
/<API Version>/mls/<MlsId>/units/<Room.Field>

HTTP Method Description Conditional Notes
GET 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": {
        "Success": true,
        "Results":[
          {
            "BathsTotal": {
              "Type": "Character",
              "ResourceUri": "/v1/unitfields/BathsTotal",
              "Label": "Bath",
              "HasList": true,
              "Searchable": false,
              "MlsVisible": [
                "B"
              ],
              "FieldList": [
                {
                  "Name": "1 Bath",
                  "Value": "1 Bath",
                  "AppliesTo": [
                    "B"
                  ]
                },
                {
                  "Name": "1 Shower",
                  "Value": "1 Shower",
                  "AppliesTo": [
                    "B"
                  ]
                },
                {
                  "Name": "2 or more Baths",
                  "Value": "2 or more Baths",
                  "AppliesTo": [
                    "B"
                  ]
                },
                {
                  "Name": "Shared Bath",
                  "Value": "Shared Bath",
                  "AppliesTo": [
                    "B"
                  ]
                }
              ]
            }
          }
      ],
    }
}
 
 

Units Metadata Description

Attribute Data Type Description
FieldList.Name Character The human-readable name of the list item.
FieldList.Value Character The universal name for the list item.
FieldList.AppliesTo Character List A list of property types the list item is enabled for.
HasList Boolean If true, there is a corresponding FieldList for this field.
Label Character The human-friendly name of this field.
MlsVisible Character List A list of property types the field is enabled for.
ResourceUri Character
Type Character The data type of the field.
 

Expansions

None.