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

Listings: Search Parameters

This page documents the parameters that may be used for the _filter parameter in a Listings API search. While the Search and Paging Syntax page documents general search parameters that apply to any service that searches, this page documents search parameters specific to the Listings API.

 

Field Parameters

Parameter Description
Standard field name Any standard field name from the Standard Fields service that is marked as searchable may be used. For example, ListPrice or BathsTotal.
Custom field group and field name The custom field group and field name from the Custom Fields service that is marked as searchable may be used. For example, "Contract Information"."Area".
HistoricalListAgentId Follows the same rules as ListAgentId, but includes all listings from past offices for that user. This field does not support multiple Id values.
HistoricalCoListAgentId Follows the same rules as CoListAgentId, but includes all listings from past offices for that user. This field does not support multiple Id values.
HistoricalBuyerAgentId Follows the same rules as BuyerAgentId, but includes all listings from past offices for that user. This field does not support multiple Id values.
HistoricalCoBuyerAgentId Follows the same rules as CoBuyerAgentId, but includes all listings from past offices for that user. This field does not support multiple Id values.
ListingCart Listings may be limited by listing cart ID. A ListingCart cannot be combined with other fields for filtering, so it should be the only field in a filter.
ListPriceHigh Because the logic behind the scenes various by MLS, this field only supports the Bt operator.
ListPriceLow Because the logic behind the scenes various by MLS, this field only supports the Bt operator.
MapCoordinate This standard field is special only in that it supports the range function.
EmailLink Listings may be filtered by email link ID. An EmailLink cannot be combined with other fields for filtering, so it should be the first and only field in a filter.
SavedSearch Listings may be limited by saved search ID. For example, the IDX Links service returns a saved search ID. A SavedSearch cannot be combined with other fields for filtering, so it should be the first and only field in a filter.
SharedListings Listings may be limited by shared listing ID; for example, 15Ar might be one possible value.
StreetAddress Performs a "smart" street address search for the first line of a street address, as opposed to directly matching the string value of a field such as UnparsedFirstLineAddress. Does not support wildcards -- instead, opt for user inputted street address criteria, such as "120 1st Street".
OpenHouses Listings may be limited to those that have open houses within a specific time frame using a datetime value.
RentalCalendar Listings may be limited to those that are scheduled for rental within a specific time frame using a date value.
TourOfHomes Listings may be limited to those that have tours within a specific time frame using a datetime value.
MlsId If omitted, all listing searches are scoped to the current MLS. Datasharing agreements amongst MLSs may provide access to listings beyond the current MLS, and can be discovered by using the Standard Fields service. To search for these listings, specify the MlsId of one or more MLSs listed by the Standard Fields service in the filter string.
Location Listings may be searched by geographic area. A search shape is required for this field, and shape the following functions are available to build the shapes:
  • linestring('latitude1 longitude1, latitude2 longitude2, ...')
    Line String searches search for listings across a generated line shape of the input coordinates.
  • polygon('latitude1 longitude1, latitude2 longitude2, latitude3 longitude3, ...')
    Polygon searches generate a shape for the ring of input coordinates. Polygons whose longitude span over 90 degrees will be ignored.
  • rectangle('latitude1 longitude1, latitude2 longitude2')
    Rectangle searches generate a shape using bounding box for the two input coordinates.
  • radius('latitude1 longitude1',radius)
    Radius searches generate a circle at center point for the input coordinates with a size of the radius as a decimal in miles.
  • radius('<Listing.ListingKey>',radius)
    A radius search can also be performed with a given listing's location as the center point.
Radius Listings may be searched for within a radius of a geographic point. This feature is similar to the radius() function for the Location field, but is supported by all MLSs.
Radius Eq latitude,longitude,radius
Radius searches generate a circle at center point for the input coordinates with a size of the radius as a decimal in miles.
 

_orderby Parameters

Listings may be ordered by any searchable main list field from the Standard Fields service, or by the ModificationTimestamp field.

You can also order listings by the special _orderby fields below:

Field Description
Random With _orderby=Random, listings that match your _filter will be returned in random order. Note that randomizing listings can be a slow process on large data sets, so be sure to provide a _filter that limits the number of listings you are randomizing.
StarRating With _orderby=StarRating, listings will be returned by their StarRating value in a consumer's Favorites cart.

MultiSelect Fields

Listing fields with MultiSelect set to true in the Standard Fields meta data are searched just like all listing fields with a FieldList:

_filter=PoolFeatures Eq 'Private'
 

Read more about MultiSelect fields here.