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 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
FloPlan
Terms of Use

Selections

The _select parameter allows you to specify the top-level data components you need. For larger data sets, such as listings, using this parameter will greatly reduce data retrieval time.

Parameter Description
_select A comma separated list specifying the attributes to be returned in the response payload.

While _select applies to top-level attributes for most services, a notable exception is the Listings API. For listings, _select applies both to StandardFields and CustomFields attributes. Also, many expansions support selecting expansion attributes. Consult the expansion table for resources to find expansions that support this feature.

For example, passing the _select=ListingId parameter to /<API Version>/listings will cause only the StandardFields.ListingId attribute to appear:

{
    "D": {
        "Success": true,
        "Results": [
          {
                "ResourceUri": "/vX/listings/20060412165917817933000000",
                "Id": "20060412165917817933000000",
                "StandardFields": {
                    "ListingId": "10-1796"
                }
          }
        ]
    }
}
 

Multiple Selections

Multiple selections can be specified with a comma separated list:

 _select=ListingId,MlsStatus
 

Selecting Custom Fields

Custom fields can be selected using the group.field format. For example _select=\"Safety Features\".\"Fire Sprinkler\" would result in:

{
   "D":{
      "Results":[
         {
            "CustomFields":[
               {
                  "Main":[
                     {
                        "Safety Features":[
                           {
                              "Fire Sprinkler":true
                           }
                        ]
                     }
                  ]
               }
            ],
            "Id":"20041105212720749673000000",
            "StandardFields":{
               "MlsId":"20000809145531659995000000",
            }
         }
      ],
      "Success":true
   }
}
 

Custom fields can be selected along side standard fields and expansions. An example of multiple selections with a mixed retrieval would look like:

_select=ListingId,\"Safety Features\".\"Fire Sprinkler\",Photos.Name
 

Selecting on Expansion Attributes

For expansions that support the feature, selections on expansion attributes can be made by namespacing the expansion and the attribute with a period:

_select=Photos.Uri800,Photos.Name
 

Expansion attributes may be limited in number (currently only supported for photos). For example, if only the first 5 photos were desired, that may be specified by passing a modifier to the expansion:

_select=Photos(5)
 

Expansion attributes may also be limited by filter (also only supported for photos). The below example shows how this can be used to only return listing photos that have the 'Room.Living' Tag:

_select=Photos(_filter=Tags Eq 'Room.Living')
 

These also work with the attribute namespaces as shown above:

 
_select=Photos(5).Uri800,Photos.Name
 
_select=Photos(_filter=Tags Eq 'Room.Living').Uri800