Listing Response Fields Selection

This documentation has moved to the Spark Platform website. Please click here to view.

This page documents the _expand parameter, which is the way to specify which fields are returned in the Listings API response.

Defaults

In all cases, the following fields are always returned regardless of the _expand parameter:

  • ListingId
  • ListingKey
  • ModificationTimestamp

If _expand=0 or _expand is not specified, the following fields are returned along with URIs for sub-resources:

     ListingId
     ListingKey
     ModificationTimestamp

     StreetNumber
     StreetDirPrefix
     StreetName
     StreetSuffix
     StreetDirSuffix
     StreetAdditionalInfo
     City
     StateOrProvince
     PostalCode

     PropertyType
     MlsStatus
     MlsStatusInformation
     ListPrice
     BedsTotal
     BathsTotal
     YearBuilt
     BuildingAreaTotal
     PublicRemarks

     ListOfficeName

If _expand=1, all fields are returned.

Standard Fields

Standard fields may not be identified individually by name at this time.

Custom Fields

Custom fields may be only identified as a whole; in other words, _expand=CustomFields will return all custom fields, and there is no way to specify individual custom fields.

Sub-Resources

Sub-resources are specified by name. For example, to retrieve photos and open houses, send this:

_expand=Photos,OpenHouses

Photos and open houses are currently supported.

Comments on this entry are closed.