Property Types
Property types may be specified with the &propertytype= parameter. This field accepts a comma separated list of property type names. When more than one MLS is searched, the property type names change to generic names rather than those names as customized by the MLS (e.g. “Single Family” may become “Residential” when more than one MLS is chosen). The list of generic names include Residential, MultiFamily, Land, Commercial, Farm, and Rental.
Example(Residential Property Type): https://link.flexmls.com/1g7s0kp1w84x,4&propertytype=A
Listing Numbers
Specific listings may be retrieved by MLS number using the ?listing= parameter. Multiple list numbers may be retrieved by specifying the MLS numbers in a comma-separated list.
Example (Two Featured Listings):
https://link.flexmls.com/1g7s0kp1w84x,4?listing=21-2608,21-2638
Main Fields
Parameter name: the field’s name
A main list field may be specified either by its field ID or by its display value with any white space removed. So, if “Begin Date” is that field’s label, a listing’s begin date may be specified by either &begin_date= or &BeginDate=.
Common field IDs include the following: list_price, house_nbr, streetdirprefix, streetaddress, streetsuffix, streetdirsuffix, city, state, zip, total_sqft, yr_built, total_br, total_bath . Not all MLSs use all of these fields, but they should be relatively common across all MLSs and property types. Some example exceptions include bathrooms and bedrooms for commercial or land property types.
The characters #.{}|^~[]`+?& should be omitted from the display value.
Date queries are specified with dates in the form of MM/DD/YYYY. If a date range is desired, the start and end of the range should be separated by a comma; for example, &BeginDate=01/01/2011,12/31/2011 . If only one date is supplied, the search will return results that match that single date.
| Example Date Parameter | Description |
|---|---|
| &BeginDate=01/01/2009 | a begin date of exactly 01/01/2009 |
| &BeginDate=01/01/2009,06/01/2009 | a begin date range from 01/01/2009 to 06/01/2009 |
Text field queries are specified by the parameter followed by a string, like the following: &streetaddress=Broadway
List items are specified by the values (not the display values) of the scroll fields. Multiple list items should be comma-delimited. For example: &City=Fargo,Moorhead
Numeric field queries may be specified as a single value, as a range, or as upper and lower ranges:
| Example Numeric Field Parameter | Description |
|---|---|
| &TotalBathrooms=5 | exactly 5 bathrooms |
| &TotalBathrooms=3,5 | a range of 3 to 5 bathrooms |
| &TotalBathrooms=>3 | at least three bathrooms |
| &TotalBathrooms=<3 | at least one, but no more than three |
Detail Fields
Detail fields may only be referenced by their display values, with any white space removed. Parameters are case sensitive. As with main list fields, the detail field must be a field present in the saved search or the quick search. The detail’s group is not referenced in the parameter; for example, if a detail “Dishwasher” is in the detail group “Appliances”, the detail name is needed but the group name is not.
The characters #.{}|^~[]`+?& should be omitted from the field name.
Examples using the various data types of detail fields are below.
| Detail Field Data Type | Description | Example Parameter |
|---|---|---|
| Text fields | Parameter must include text to for which to search | &CondoName=Waterly |
| Yes/No fields | Possible parameters include Y or N | &RentalSignAllowed=Y |
| List fields | Parameters must exactly match the list items. Since a detail list field may only contain a single value, specifying multiple values separated by commas will return listings that match at least one of the specified values. | &LakeName=Cormorant,Ottertail |
| Date fields | Parameters follow the same format as main list fields: MM/DD/YYYY . A date range may be specified by including two dates separated by commas. | &LeaseExpiration=04/13/2011,04/13/2012 |
| Numeric fields | Ranges may be specified by including two numbers separated by a comma. | &AssociationFee=100.00,200.00 |