The [vista_listings_list]
shortcode takes a variety of URL parameters to filter the listings which it displays. Any listing displayed must satisfy ALL conditions set by URL parameters. Some URL parameters can be specified multiple times- in this case, displayed listings only have to satisfy one of the values for the repeated parameter. For example, ?cities=Houston&cities=Atlanta
displays listings in both Houston and Atlanta. If the URL parameters are too restrictive to match any listings, the message "No listings matched your query" (with no associated HTML elements) is displayed.
Keep in mind that the displayed results are also limited by the data provided by your MLS. For example, if your MLS is local to the state you're in, it probably won't have listings from out of state. So, if you specify a different state in the URL parameters, you might not get any listings back.
Our included forms automatically insert these URL parameters when they redirect to the destination page after submission. This is how the forms filter results on the page that they point to.
Example
yoursite.com/listings?status=Active&minprice=100000&maxprice=400000&cities=Houston
Assuming the page yoursite.com/listings contains a [vista_listings_list]
shortcode, this shortcode will only display active listings in Houston with a list price between $100,000 and $400,000.
Parameter Names and Values
Parameter | Description |
q | A keyword search. Searches the following fields: listingId, street number, street name, mls area (major), city, subdivision name, postal code. The q parameter can be specified multiple times in a query. |
status | Status of the listing, defaults to status. Accepts the following values: Active, Pending, Closed, ActiveUnderContract, Hold, Withdrawn, Expired, Delete, Incomplete, ComingSoon; although your MLS may not offer all of these. Multiple statuses can be specified in one query. |
type | Property type of the listing; defaults to Residential and Rental. Multiple types can be specified in one query. Available values: residential, rental, mobilehome, condominium, multifamily, commercial, land, farm. |
subtype | Property subtype- not all values are available for all MLSs. All possibly available values: apartment, boatslip, singlefamilyresidence, deededparking, cabin, condominium, duplex, manufacturedhome, ownyourown, quadruplex, stockcooperative, townhouse, timeshare, triplex, manufacturedonland, farmandranch, agriculture, business, hotelmotel, industrial, mixeduse, officespace, retail, unimprovedland, warehouse. |
subTypeText | The originial subtype value from the MLS- possible values differ based on the MLS. |
agent | Filters by the listAgent ID, provided by the MLS. |
salesAgent | Filters by the sales.agent ID, provided by the MLS. |
brokers | Filters by the broker ID, which is often the ListOfficeId field. This parameter can be specified multiple times, but is not available for all MLSs. |
specialListingConditions | Filters by special listing conditions like REO, Short Sale, Auction, etc. Fields provided vary between MLSs. |
ownership | Filters by the ownership field- possible values differ by MLS. |
minprice | Minimum price. |
maxprice | Maximum price. |
minarea | Minimum area in square feet. |
maxarea | Maximum area in square feet. |
minbeds | Minimum number of bedrooms. |
maxbeds | Maximum number of bedrooms. |
minbaths | Minimum number of bathrooms. |
maxbaths | Maximum number of bathrooms. |
maxdom | Maximum days on market for a listing- not available for all MLSs. |
minlistdate. | Most recent acceptable date for listings- all returned will have been listed on or older than this date. Takes ISO 8601 format; defaults to UTC if timezone is not set. |
maxlistdate | Oldest acceptable date for listings- all returned will have been listed on or newer than this date. Takes ISO 8601 format; defaults to UTC if timezone is not set. |
minyear | Minimum year built. |
maxyear | Maximum year built. |
minacres | Minimum acreage. |
maxacres | Maximum acreage. |
minGarageSpaces | Minimum number of garage spaces. |
maxGarageSpaces | Maximum number of garage spaces. |
limit | Maximum number of listings to return (per page). Defaults to 20, maximum is 500. |
offset | Offset for pagination. Defaults to 0. |
postalCodes | Filters by zip/postal code. This parameter can be specified multiple times. |
features | Filters by interior features; options vary by MLS. This parameter can be specified multiple times. |
exteriorFeatures | Filters by exterior features; options vary by MLS. This parameter can be specified multiple times. |
water | Filters by water body name, as specified in the .property.water field. Can be set to true to filter properties that have something in the .property.water field, false to return listings where .property.water is false or NULL, or any string to specify a body of water. Can be specified multiple times in a single query. |
neighborhoods | Filters by neighborhood name. Can be specified multiple times. Available values differ by MLS |
cities | Filters by city name, case-insensitive. Can be specified multiple times. Available values differ by MLS |
state | Filters by state or province name, case-insensitive. Can be specified multiple times. |
points | Returns listings that are within a set of lat, long coordinates. Must be specified multiple times, one for each point, at least 3 times. Each point should have the format [lat],[long] |
idx | Filters by idx requirements by checking the internetAddressDisplay and internetEntireListingDisplay fields. The default is NULL, in which case both fields must be true. Setting idx=listing indicates that only internetEntireListingDisplay must be true. Setting idx=address indicates that only internetAddressDisplay must be true. Setting idx=ignore ignores both fields. |
include | Includes fields in each listing which are not included by default. Available values: association, agreement, garageSpaces, maintenanceExpense, parking, pool, rooms, taxYear, taxAnnualAmount. |
sort | Sort the response by a specific field- a minus - sign before the field denotes descending order, while the default is ascending. Available values: listprice, -listprice, listdate, -listdate, closedate, -closedate, beds, -beds, baths, -baths. |