Docs

Note: This documentation is currently undergoing renovation. Check back in the following weeks as we correct errors and add more details. In the meantime, you can get support here.

The Vista plugin allows the retrieval and display of listings from any MLS. Unlike similar plugins, the format of displayed listings is fully customizable. Instead of having to choose from a limited subset of themes, Vista allows 100% custom HTML within listing displays, which can then be customized with CSS. Unlike other plugins, websites built with Vista look different from each other, so your listings will reflect the same theme and branding as the rest of your site.

After installation, Vista displays dummy data by default, so you can start building without committing to any purchase. Once you’re ready to display live data, you first must purchase a subscription from your desired MLS. The MLS will give you an API key, which you can enter on the MLS activation page. Once we receive this information, our team will get in contact with your local MLS provider and set up a data feed for your website. Once we have set everything up, we will email you with further instructions.

If you need Support, please fill out the form in the Support Portal, which you will need to login to view.

Forms Installation and Embedding

Built-in Forms:

VistaWP provides convenient built-in forms that you can seamlessly integrate into your website. These forms are designed to enhance user experience and streamline the process of searching for listings. You can choose from the following built-in forms, each tailored to different search requirements:

• [vista_basic_form]: This shortcode enables you to embed a fundamental search form effortlessly.
• [vista_advanced_form]: Utilize this shortcode to integrate an advanced search form, offering more intricate search options.
• [vista_search_form]: This shortcode offers just the search field and nothing else

[vista_basic_form]

[vista_advanced_form]

[vista_search_form]

Integration with Fluent Forms:

VistaWP also offers integration with both the Lite and Pro versions of Fluent Forms, though the Pro version is recommended for enhanced functionality. If you’re using Fluent Forms, you can follow these steps to seamlessly embed VistaWP forms into your website:

1. Install the Fluent Forms plugin on your WordPress website.
2. Visit the VistaWP downloads page and download the search forms JSON file containing our preset forms.
3. Import the JSON file via the Fluent Forms settings page to include our pre-designed forms in your system.
4. Once the import is successful, navigate to the Fluent Forms section and select the desired form you wish to use.
5. Click the “Embed” button located at the top-right corner of the form interface.
6. Copy the generated shortcode.
7. Paste the copied shortcode onto the relevant page where you want the form to appear.

We also extend compatibility with the Pro version of Formidable Forms and other form builder plugins that support URL parameters, though our built-in forms are specifically designed to work seamlessly with Fluent Forms. If you’re using Formidable Forms, you can explore ways to integrate the forms as per their compatibility options.

Redirecting Form Results to Vista

Vista Built-in Forms and URL Parameters:

VistaWP’s built-in forms offer a seamless way to search through listings by utilizing specific URL parameters. These parameters are extracted from the URL of the page where the forms are embedded. The URL parameters take the form of ?minprice=10000&maxprice=200000 and are generated by the forms that redirect users to the respective page.

To enable efficient form-based listing searches, follow these steps:

1. Ensure that your WordPress permalinks are set to “Post Name.” This setting, found under Settings > Permalinks, assigns each page’s slug as its name. This facilitates the redirection of forms to the correct pages for effective search interactions.
2. By default, the templates provided by Fluent Forms redirect to pages with the slugs “listings” and “open-house.” However, you have the flexibility to customize these slugs as needed.

Vista Shortcodes and Parameter Extraction:

Vista’s shortcodes are designed to parse the URL for specific parameters, meticulously detailed in the dedicated sections for each shortcode. Although our Fluent Forms templates offer a streamlined method to incorporate search parameters into the URL, you can utilize any approach that involves parameter names outlined in the provided tables below.

These parameter sources can range from your own custom-built forms, hardcoded URL modifications, or any mechanism that adjusts the URL when redirecting to the relevant page.

Optimizing Query Combinations:

It’s important to note that certain combinations of parameters might become overly restrictive, resulting in no matching listings from your MLS. In such cases, the Vista shortcode will gracefully display “No listings matched your query.”

By following these instructions, you can seamlessly integrate Vista’s built-in forms, harness the power of URL parameters, and facilitate efficient listing searches on your website.

Displaying Multiple Listings

This shortcode displays multiple MLS listings, as in search results, in a completely flexible and customizable way. The opening and closing tags of the shortcode are used to bracket an area of HTML which is used as a template for each listing. Within this template, shortcodes corresponding to listing fields are used to indicate where to insert data from the API. When the page is loaded, this template is repeated on the page for every listing returned by the API, with each internal shortcode replaced by data from the corresponding field and listing.

The displayed listings can be filtered by various URL parameters, which will be added to the docs shortly. For now, you can use the Fluent Forms templates to filter listings, which come with a wide variety of default search parameters.

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.

Example

[vista_listings_list]
<p>[address]</p>
[/vista_listings_list]

In the screenshot below, you can see the shortcode block above in action. For each of the 20 listings (which is the default limit) returned from the API, a <p> element is displayed on the page, with the “address” field inside the <p> element. This concept works in any context, with any HTML elements, and can even be used with page builders by wrapping a template area in the start and end tags of this shortcode.

You can use the following fields as internal shortcodes within the vista_listings_list shortcode

accessibility	accessibility information	“handicap”
additionalRooms	additional room information
address	Full address of property	“123 fake st, Nampa, ID 90210”
amenities	Property amenities	“hoa-”
area	area of property	“Boise Bench – 0400”
areaMinor	??
areaSource	where area measurements were provided	“Plans”
bathsFull	Number of Baths	“2”
bathsHalf	Number of Half Baths if available	“2”
bathsThreeQuarter	number of ¾ baths
bedrooms	Number of Bedrooms	“4”
city	City of Property	“Nampa”
construction	construction material details	“Concrete, Frame, Masonry, Stone, Wood Siding”
cooling	type of cooling system	“Central Air”
country	Country of property	“United States”
county	County of the property	“Elmore”
crossStreet	Closest cross streets if available
daysOnMarket	Number of Days on the market	“12”
directions	General Directions on how to arrive	“Off Highway 30, Right on East 12th,First left onto Blossom”
disclaimer	Property Disclaimer	“This information is believed to be accurate, but without warranty”
elementarySchool	Elementary School Name	“Joplin”
exteriorFeatures	property exterior information
fee	Hoa fee	“hoa-400”
fireplaces	Number of fireplaces	“1”
first-photo	first property photo, this can go all the way up to 10 eg..([second-photo], [third_photo]) etc
first-photo-url	url for first property photo, this can go all the way up to 10 eg..([second-photo-url], [third_photo-url]) etc	“https://dvvjkgh94f244.cloudfront.net/1644840e/98844821/83dcefb7.jpeg”
flooring	Type of flooring	“Carpet”
foundation	foundation type	“Crawl Space”
frequency	hoa frequency of payment	“hoa-Annually
full	Full address without city, state or zipcode	“123 Fake st”
garageSpaces	number of garage spaces	“4”
heating	Type of Heating	“Forced Air, Natural Gas”
highSchool	High School Name	“Centennial”
interiorFeatures	Interior details	“Bath-Master, Split Bedroom, Two Master Bedrooms, Dual Vanities, Walk-In Closet(s), Pantry”
internetAddressDisplay	shows a one if listing is valid	“1”
internetEntireListingDisplay	shows a one if listing is valid	“1”
lat	Latitude Coordinates	“43.148351”
laundryFeatures	laundry information	“220v”
leaseTerm	lease terms
leaseType	current lease type
listDate	Listing Date if Available
listingId	Listing id for the property ( used for viewing individual property)	“98850267”
listPrice	Price of the listing	“995,000”
lng	Longitude Coordinates	“-115.707028”
lotDescription	Description of the lot	“10000 SF – .49 AC, Garden, R.V. Parking, Auto Sprinkler System, Full Sprinkler System”
lotSize	size of lot with dimensions	“115×72”
lotSizeArea	are size lot	“0.19”
lotSizeAreaUnits	unit of measurement used for property	“Acres”
maintenanceExpense	Maintenance expenses	“150”
marketArea	Market Area according to MLS	“Mtn Home-Elmore – 1500”
middleSchool	Middle School Name	“Lowell Scott Middle”
mlsId	mls id (needed for viewing individual listing)	“179391775”
name	hoa name	“hoa-”
occupantName	name of occupant
occupantType	type of occupancy
office-brokerid	broker id
office-cell	broker cell phone
office-email	Broker email
office-name	broker name
office-phone	broker phone
originalEntryTimestamp	time entered into mls
originalListPrice	The original List Price if available
originatingSystemName	Name of Origin MLS	“IMLS 2”
ownerName	Property owners name if available
ownership	Ownership details	“Fee Simple,Fractional Ownership: No”
parking-description	Parking description	“Attached, RV Access/Parking, Finished Driveway”
parking-leased	Parking lease information
parking-spaces	parking space information	“1”
pool	Details of swimming pool if available
postalCode	Postal code of property	“90210”
remarks	a description of the property	“Inviting 2-story home located in one of Nampa’s beautiful communities in a subdivision surrounded by farmland.”
roof	Details about roof type	“Composition”
rooms	Number of rooms	“0”
sales	sales information
School-district	School District Name
showingContactName	who to contact for showing
showingContactPhone	phone number to schedule a showing
showingInstructions	Instructions for showing
specialListingConditions	listing conditions
sqftPrice	price per square foot	“474.68”
state	State of property	“ID”
status	Status of a property can return “Active” or “pending”	“Active”
statusText	status of property	“New”
stories	Stories of Property	“2”
streetName	Street name of property	“Fake st”
streetNumber	Street number of property	“123”
streetNumberText	Street number of property	“123”
style	Style of Property	“victorian”
subdivision	name of the subdivision	“Patagonia”
subType	Descriptive Type of dwelling	“SingleFamilyResidence”
taxAnnualAmount	Annual amount of taxes price	“506”
taxYear	Last tax year	“2021”
type	property Type	“RES”
type	property type	“RES”
unit	Unit number if available	“d”
view	property view information
virtualTourUrl	Link for a virtual tour	“No virtual tour available”
water	property water information
yearBuilt	Year built of the property	“2019”

 

Paginating Listings

The [vista_listings_paginator] shortcode outputs an <a> element which paginates all [vista_listings_list] and [vista_listings_map] shortcodes on this page. The attribute “type” must be set to “forward” or “backward”; the button will paginate in the corresponding direction. Forward pagination buttons have the CSS class listings-forward, backward buttons have the class listings-backward, and both have the class vista-listings-paginator. These classes can be used to apply your own custom styles to the <a> element. The limit for the total number of listings to display is passed between paginations and remains the same. The content of the <button> element is set by the content of the shortcode. In other words, any text or HTML within the start and end tags of the shortcode will be placed between the start and end tags of the <button> element.

Pagination is done via the offset URL parameter, and the limit for total listings to display is set via the limit URL parameter.

Displaying Total Number of Listings

The [vista_listings_total] shortcode outputs the total number of listings that match the query criteria set in the URL, which is usually more that the number displayed on the page, since that is limited by the limit parameter. No additional HTML is included in the output, so this should be wrapped in a suitable element.

Example

<h3>Total of [vista_listings_total] results</h3>

Displaying Fields from Individual Listings

The [vista_listing_field] shortcode displays a single field from a single listing, and is often used on pages which are linked to from search results and display the details of a single listing. The listing to pull the field from is set by the listing parameter in the URL, which must be set to a valid ID. This ID should be retrieved from the mlsID field of the listing, which can be obtained using the shortcodes for multiple listings. The field to pull is defined in the field shortcode attribute, and must be set to a valid field from the table below. No HTML is included in the output of this shortcode (except for certain fields which require HTML, such as the various dynamic photo displays), only the data itself, so you may style it in any way you like.

Note that there is also a listingID field available within listing data. If used for the listing URL parameter, this will NOT return a valid result. Instead, as in any case where the listing URL parameter is invalid or unset, all instances of the [vista_listing_field] shortcode will return an error message.

Example

[vista_listing_field field=address]

You can use the following options within the vista_listing_field shortcode

accessibility	accessibility information	“handicap”
additionalRooms	additional rooms information
address	property address	“9174 W Taco farm, Boise, ID 83709”
amenities	Hoa amenities	“hoa-”
area	property area information	“Boise SW-Meridian – 0550 ”
areaMinor	returns blank
areaSource	area source	“Public Records”
bathsFull	property full baths information	“3”
bathsHalf	property half baths information
bathsThreeQuarter	property three quarter baths information
bedrooms	property bedrooms information	“3”
city	address city	“Boise”
coAgent	co Agent information
construction	property construction information	“Frame, HardiPlank Type”
cooling	property cooling system information	“Central Air”
country	address country	“United States”
county	address county	“Ada”
crossStreet	address cross streets
daysOnMarket	property days on market	“45”
description	Property description	“Attached, Alley Access”
directions	property directions	“ Lake Hazel / S on Sea Breeze / E on W Rustica / N Alderberry / N LoganBerry / E on Patina”
disclaimer	proeprty disclaimer	“This information is believed to be accurate, but without warranty.”
District-school	school district name
elementarySchool	elementary school name	“Desert Sage”
exteriorFeatures	exterior features information
fee	hoa fee	“hoa-475”
fireplaces	fireplace information
first-photo	first property photo, this can go all the way up to 10 eg..([second-photo], [third_photo]) etc
first-photo-url	url for first property photo, this can go all the way up to 10 eg..([second-photo-url], [third_photo-url]) etc	“https://dvvjkgh94f244.cloudfront.net/1644840e/98844821/83dcefb7.jpeg”
flooring	property flooring information	“Carpet, Vinyl/Laminate Flooring”
foundation	property foundation information
frequency	hoa frequency	“hoa-Annually”
full	full address	“9174 W Taco farm Dr”
garageSpaces	number of garage spaces	“2”
heating	heating information	“Forced Air, Natural Gas”
highSchool	high school name	“Mountain View”
id	returns a string	R1376790150
interiorFeatures	interior features information	“Bath-Master, Walk-In Closet(s), Pantry”
internetAddressDisplay	internet address display returns 1 if true	“1”
internetEntireListingDisplay	internet address display returns 1 if true	“1”
lat	latitude coordinates	“43.542909”
laundryFeatures	laundry information	“220v”
leaseTerm	current lease information
leaseType	lease type information
listDate	date of listing
listingId	listing id	“98844123”
listPrice	listing price	“400,000”
lng	longitude coordinates	“-116.296624”
lotDescription	let description	“Standard Lot 6000-9999 SF, Sidewalks, Auto Sprinkler System, Full Sprinkler System, Pressurized Irrigation Sprinkler System”
lotSize	lot size measurements	“100×60”
lotSizeArea	lot size area	“0.138”
lotSizeAreaUnits	Lot size units	“Acres”
maintenanceExpense	maintence expense information
marketArea	market area name	“Boise SW-Meridian – 0550”
middleSchool	middle school name	“Lake Hazel”
mlsId	Mls ID number	“179011165”
name	hoa name	“hoa-”
occupantName	name of current occupant if available
occupantType	returns blank
office-brokerid	broker id for property	“123456”
office-cell	cell phone for broker	‘’555-222-5555”
office-email	email address for broker
office-name	name of broker	“Keller Williams”
office-phone	Phone number of realtor office	“555-222-5555”
originalEntryTimestamp	returns blank
originalListPrice	returns None
originatingSystemName	returns a string	“IMLS 2”
ownerName	returns blank
ownership	returns a string	“Fee Simple”
Parking-leased	Returns None
Parking-spaces	returns a number	“1”
photos	returns a slider of photos
photos-masonry	returns a masonry slider of photos
pool	returns blank
postalCode	address postal code	“83709”
privateRemarks	returns None
remarks	property remarks	“MAJOR PRICE IMPROVEMENT!! Opportunity awaits! ”
roof	property roof type	“Composition”
rooms	returns a number	0
sales	returns None
showingContactName	name of person to contact for showing
showingContactPhone	phone number to contact for showings
showingInstructions	proeprty showing instructions
specialListingConditions	special listing conditions
state	state of address	“ID”
status	property status	“Active”
statusText	property status	“Active”
stories	property stories
streetName	address street name	“W W Taco farm Dr”
streetNumber	address street number	“9174”
streetNumberText	address street number	“9174”
style	style of property
subdivision	name of subdivision	“ Charter Pointe”
subType	type of property	“SingleFamilyResidence”
taxAnnualAmount	annual amount of tax	“1023”
taxYear	last property tax year	“2021”
type	property type	“RES:
unit	property unit number	‘’2c”
view	property view information
virtualTourUrl	url for virtual tour if available	“No virtual tour available”
water	water information
yearBuilt	year property was built	“2008”

Displaying Multiple Open Houses

The [vista_openhouse_list] shortcode works just like the [vista_listings_list] shortcode, except that it pulls open house listings instead of for sale listings. Correspondingly, a few extra fields specific to open houses (such as startTime and endTime) are available. Like [vista_listings_list], the start and end tags are of the [vista_openhouse_list] shortcode are used to wrap a section of HTML, which is used as a template for each displayed listing. This template is repeatedly output onto the page for each listing returned by the API. Within the template, shortcodes can be used to specify where to insert data from the API. Each shortcode within the start and end tags is replaced with the data from the field specified, and this process is repeated for each returned listing.

Example

[vista_openhouse_list]

<p> [address] </p>

[/vista_openhouse_list]

Here we can see the result of the above code with sample data. For each open house returned by the API, the [address] tag is replaced with the actual address of that open house. This works with any HTML elements and any valid fields. Valid fields are specified in the table below.

Fields

accessibility	accessibility type	“handicap”
additionalRooms	additional room info
address	full address	“1428 W king kong St, Kuna, ID 83634”
amenities	hoa amenities	“hoa-”
area	name of area	“Kuna – 1100”
areaMinor	??
areaSource	source for area information	“Plans”
bathsFull	full baths of property	“3”
bathsHalf	half baths of property	“3”
bathsThreeQuarter	three quarter baths if available	“3”
bedrooms	number of bedrooms	“3”
city	city of address	“Kuna”
coAgent	Co-agent information
construction	Construction type	“Frame”
cooling	type of cooling system	“Central Air”
country	Country of open house	“United States”
county	County of property	“Ada”
crossStreet	name of cross street
daysOnMarket	number of days on market	“2”
description	description of open house
directions	directions to property	“From Ustick: S. on Blairmore, R on Stanhope to address”
disclaimer	disclaimer information	This information is believed to be accurate, but without warranty.
elementarySchool	name of elementary school	“River Valley”
endTime	end time of open house	“Jul 11, 2022: 12:00 PM”
exteriorFeatures	detail about exterior of property
fee	hoa fee	“hoa-210”
fireplaces	Number of fireplaces	“1”
first-photo	first property photo, this can go all the way up to 10 eg..([second-photo], [third_photo]) etc
first-photo-url	url for first property photo, this can go all the way up to 10 eg..([second-photo-url], [third_photo-url]) etc	“https://dvvjkgh94f244.cloudfront.net/1644840e/98844821/83dcefb7.jpeg”
flooring	type of flooring	“Carpet”
foundation	type of foundation
frequency	hoa fee frequency	“hoa-Quarterly”
full	full address	“1428 W king kong St”
garageSpaces	number of garage spaces	“3”
heating	type of heating	“Forced Air, Natural Gas”
highSchool	name of high school	“Meridian”
id	id of property	“R1619230690”
interiorFeatures	details about interior of property	“Bath-Master, Dual Vanities, Walk-In Closet(s), Breakfast Bar, Pantry, Kitchen Island”
internetAddressDisplay	if address is avalable returns 1	“1”
internetEntireListingDisplay	if listing is avalable returns 1	“1”
lat	latitude coordinates	“43.631887”
laundryFeatures	laundry information	“220v”
leaseTerm	terms of current lease
leaseType	current lease type
listDate	Date Listed
listingId	returns a long number	“98850269”
listPrice	listing price	“455,000”
lng	longitude coordinates	“-116.407826”
lotDescription	description of lot	“Sm Lot 5999 SF, Irrigation Available”
lotSize	size of lot
lotSizeArea	lot size area	“0.126”
lotSizeAreaUnits	lot size area measuring unit	“Acres”
maintenanceExpense	Maintenance expenses
marketArea	Market area	“Meridian NW – 1030”
middleSchool	name of middle school	“Meridian Middle”
mlsId	mlsid for the property	“175595065”
name	hoa name	“hoa-”
occupantName	name of current occupant
occupantType	type of occupant for property
openHouseId	id of the openhouse	“4029728”
openHouseKey	** open house identifier (willl be needed for invidual open house listing )	“21022215”
originalEntryTimestamp	Time of Open house entry
originalListPrice	Original listing price if available
originatingSystemName	name of MLS	“IMLS 2”
ownerName	name of owner if available	“bank”
ownership	details about ownership	“Fee Simple,Fractional Ownership: No”
pool	pool information if available
postalCode	postal code number	“83634”
privateRemarks	private remarks about the openhouse
refreshments	available refreshments
remarks	notes about the proerty	“Charming home in Crossfield community located within walking distance to Settler’s Park”
roof	roof type	“Composition”
rooms	number of rooms	“0”
sales	sales information
schoolDistrict
showingContactName	showing contact name
showingContactPhone	showing contact phone
showingInstructions	Instructions for showing
specialListingConditions	details about listing conditions
startTime	start time of open house	“Jul 11, 2022: 10:00 AM”
state	state of property	“ID”
status	status of listing	“Active”
statusText	status of listing	“New”
stories	stories of property	“2 stories”
streetName	street name of property	“W king kong St”
streetNumber	street number of property address	“1428”
streetNumberText	street number of property address	“1428”
style	style of property
subdivision	subdivision name	“Cazador”
subType	subdivision type	“SingleFamilyResidence”
taxAnnualAmount	annual amount of tax	“1419”
taxYear	last tax year	“2021”
type	type of openhouse	“Public”
unit	unit number for address
view	information about view of property
virtualTourUrl	link to a virtual tour	No virtual tour available
water	information about water
yearBuilt	year property was built	“2022”

Paginating Open Houses

The [vista_openhouse_paginator] shortcode outputs a button which paginates all [vista_openhouse_list] shortcodes on this page. This shortcode works exactly like [vista_listings_paginator], except that it paginates the open house shortcode instead of the listings one. The attribute “type” must be set to “forward” or “backward”; the button will paginate in the corresponding direction. Forward pagination buttons have the CSS class listing-forward, backward buttons have the class listings-backward, and both have the class vista-listings-paginator. If the limit URL parameter is set, the next page will contain the same number of listings. Otherwise, the default limit is 20 listings. The content of the <button> element is set by the content of the shortcode. In other words, any text or HTML within the start and end tags of the shortcode will be placed between the start and end tags of the <button> element.

Example

[vista_openhouse_list]
<a href="/mctest/?listing=[mlsId]">[address]</a>
[/vista_openhouse_list]
<br>
[vista_openhouse_paginator type=backward]Previous[/vista_openhouse_paginator]
[vista_openhouse_paginator type=forward]Next[/vista_openhouse_paginator]

Displaying Total Number of Open Houses

The [vista_openhouse_total] works the same way as the [vista_listings_total] shortcode, except it displays the total number of open house listings instead of the total number of property listings. This total often differs from the number of listings displayed on the page, since the number displayed is limited by the limit parameter. Note that no HTML is output along with the total, so this shortcode should be wrapped in an appropriate element.

Example

[vista_openhouse_total]

Displaying Fields from Individual Open Houses

The [vista_openhouse_field] shortcode can be used to display individual fields from a given open house listing. The listing to pull fields from is defined by the openhouse URL parameter, which must be set to a valid mlsId which corresponds to an open house listing. This mlsId is a field which can be obtained from the [vista_openhouse_list] shortcode. The field to pull from the listing is defined by the field shortcode attribute. A table of valid field names is below.

This shortcode does not output any HTML, so it should be wrapped in a suitable element- see the example below.

Note that there is another field in the open house called listingId, and this is NOT the correct field to use in the URL.

Example

<p>[vista_openhouse_field field=privateRemarks]</p>

Here are the fields provided by the vista_openhouse_field shortcode

accessibility	accessibility information	“handicap”
additionalRooms	additional rooms info
address	full address of property	“1476 W Lochness St, Kuna, ID 83334”
amenities	hoa amenities	“hoa-”
area	area name	“Kuna – 1100”
areaMinor
areaSource	area information source	“Plans”
bathsFull	number of full baths	“3”
bathsHalf	number of half baths
bathsThreeQuarter	number of ¾ baths
bedrooms	number of bedrooms	“5”
brokerid	broker id of property
cell
city	city of address	“Kuna”
coAgent	co agent information
construction	construction info about property	“Frame, Stone, Stucco, Other”
cooling	property cooling information	“Central Air”
country	address countrty	“United States”
county	address county	“Ada”
crossStreet	address cross streets if available
daysOnMarket	number of days property is on market	40
description	property descripton
directions	directions of proeprty	“S Ten Mile, E Ardell Rd, S Coral Falls Ave, E Tiger Eye St, S Opal Falls, W lochness”
disclaimer	proeprty disclaimer	“This information is believed to be accurate, but without warranty.”
elementarySchool	elementary school name	“Kuna”
email
endTime	endtime of openhouse	“Jul 14, 2022: 5:00 PM”
exteriorFeatures	information about exterior
fee	hoa fee information	“hoa-450”
fireplaces	number of fireplaces	“1”
first-photo	first property photo, this can go all the way up to 10 eg..([second-photo], [third_photo]) etc
first-photo-url	url for first property photo, this can go all the way up to 10 eg..([second-photo-url], [third_photo-url]) etc	“https://dvvjkgh94f244.cloudfront.net/1644840e/98844821/83dcefb7.jpeg”
flooring	information about property flooring	“Tile”
foundation	information about property foundation	“Crawl Space”
frequency	frequency of hoa	“hoa-Annually”
full	full address	“1476 W lochness St”
garageSpaces	number of garage spaces	“3”
heating	property heating information	“Natural Gas”
highSchool	high school name	“Kuna”
id	an id	“R1326130460”
interiorFeatures	details about interior of property	“Bath-Master, Walk-In Closet(s), Breakfast Bar, Pantry, Kitchen Island”
internetAddressDisplay	internet address display	“1”
internetEntireListingDisplay	internet display	“1”
lat	latitude coordinates	“43.508512”
laundryFeatures	laundry features
leaseTerm	current lease term
leaseType	current lease type
listDate	listing date
listingId	listing id	“98844821”
listPrice	current listing price	“629,900”
lng	longitude coordinates	“-116.43225”
lotDescription	returns the lot description text	“Sm Lot 5999 SF, Irrigation Available, Irrigation Sprinkler System”
lotSize	lot size
lotSizeArea	lot size area	“0.126”
lotSizeAreaUnits	lot size area units of measurement	“Acres”
maintenanceExpense	maintenance expenses
marketArea	market are name	“Kuna – 1100”
middleSchool	middle school name	“Kuna”
mlsId	mls id of property	“179283034”
name	hoa name	“hoa-”
occupantName	current occupant name
occupantType	occupant type
office-brokerid	broker id
office-cell	broker cell phone
office-email	Broker email
office-name	broker name
office-phone	broker phone
openHouseId	open house id	“4035189”
openHouseKey	open house key	“21088303”
originalEntryTimestamp	original time stamp of when listed
originalListPrice	original list price
originatingSystemName	returns a string	“IMLS 2”
ownerName	name of owner if available
Parking-description	parking description	“Attached, Finished Driveway”
Parking-leased	None
Parking-spaces	returns a number	“3”
photos	slide show of photos
pool	information about swimming pool
postalCode	zip code of address	“83634”
privateRemarks	returns None
refreshments	refreshments information
remarks	remarks about the property	“Welcome to the remarkable Tully Floorplan by Venta Homes!”
roof	roof description	“Architectural Style ”
rooms	number of rooms	“0”
School-district	name of school district	“Adams”
servingName
showingContactName	showing contact name
showingContactPhone	showing contact phone
showingInstructions	showing instructions
specialListingConditions	property listing conditions
sqftPrice	property price per square foot	“238.60”
startTime	start time of open house	““Jul 14, 2022: 11:00 AM””
state	address state	“ID”
status	open house status	“Active”
statusText	open house status	“Active”
stories	property stories
streetName	address street name	“W Lochness St”
streetNumber	address street number	“1476”
streetNumberText	address street number	“1476”
style	property style
subdivision	subdivision name	“Cazador”
subType	subdivision type	“SingleFamilyResidence”
taxAnnualAmount	annual tax amount	0
taxYear	annual tax year	“2022”
type	returns a string	“Public”
unit	address unit number
view	property view information
virtualTourUrl	tour for virtual tour if available	“No virtual tour available”
water	water information
yearBuilt	returns a year	“2022”

Displaying Analytics

The [vista_analytics_field] shortcode provides general data about the properties of a set of listings. It accepts the same URL parameters as the [vista_listings_list] shortcode, however, instead of displaying a list of listings, the vista_analytics_field shortcode displays statistics about all listings that match the URL parameters. For example, if you wanted to know the number of houses in the zip code 11111 that are listed for over $400000, you would use the url parameters ?zip=11111&minPrice=400000 with the following shortcode on the page:

<p>[vista_analytics_field field=totalCount]</p>

As with the other shortcodes that output a single data value, the field attribute is used to specify which field to display. Note that no HTML is returned with the shortcode output, so it should be wrapped in an appropriate element.

The following fields are available with this shortcode:

avgLivingArea	average living area of all results
avgFullBaths	average full baths of all results
avgBedrooms	average bedrooms of all results
avgLotSize	average lot size of all results
avgPrice	average price of all results
avgYearBuilt	average year built of all results
areaDistribution	returns a table of all results with comulns of area and listings
totalCount	total number of listings from all results

Displaying Listings on a Map

The [vista_listings_map] shortcode queries the same listings and accepts the same parameters as [vista_listings_list]. However, instead of a repeater view, a map is used to display the listings. The map is contained within a div element with the ID vsta-listing-map.

[vista_listings_map]
[/vista_listings_map]

The example above produces the following map:

Of course, this map isn’t very useful without specific details about each listing. To accomplish this, when one of the blue pins on the map is clicked, details regarding the clicked listing appear underneath the map in a div element with the ID vsta-listing-map-info. As with [vista_listings_list], the format of the details that are displayed within this div is defined by the shortcode content. By adding HTML and valid field names as shortcodes to the [vista_listings_map] shortcode content, you can define a rich and complex listing format which appears under the map whenever a pin is clicked.

[vista_listings_map]
<p>[address]</p>
[/vista_listings_map]

The above example displays the address of the clicked listing under the map whenver a pin is clicked. Note that, when the page loads, there is no listing displayed; once a pin is clicked, the most recently clicked listing is displayed under the map for the rest of the time the user is on the page. There is no way to hide the listing under the map once it has been displayed; the information simply updates whenever the user clicks a new listing.

[vista_listings_map]
<p>[first-photo]</p>
<p>$[listPrice]</p>
<p>[bedrooms] BEDS</p>
<p>[baths] BATHS</p>
<p>[sqft]</p>
<p>$[sqftPrice]</p>
<p>Listing #[listingid]</p>
[viewButton]
[/vista_listings_map]

Above is a more complex example showcasing the ability to display many fields. With the addition of a little more CSS and HTML, the above code could look something like the following example:

The fields available in the [vista_listings_map] shortcode are the same as the ones available in [vista_listings_list] and [vista_listing_field]:

accessibility	property accessibility	“Handicap”
additionalRooms	property additional rooms	“2”
address	returns the address of property	“2327 N Chimichanga Way, Boise, ID 83700”
amenities	Hoa Amenities	“hoa-”
area	property area	“Boise Bench – 0400”
areaMinor	??
areaSource	are source of information	“Public Records”
bathsFull	full baths of property	“1”
bathsHalf	property half baths
bathsThreeQuarter	Property ¾ baths
bedrooms	number of bedrooms	“3”
city	city of address	“eagle”
coAgent	Co-agent info if available
construction	construction information	“Frame, Stucco, Wood Siding”
cooling	property cooling information	“Central Air”
country	property address country	“United States”
county	property address county	“Ada”
crossStreet	property cross streets
daysOnMarket	number of days on MLS	“33”
directions	directions to property	“From Vista and Cassia turn West on Cassia to Opal St then turn North to address”
disclaimer	disclaimer	“This information is believed to be accurate, but without warranty.”
elementarySchool	property elementary School	“Seven Oaks”
exteriorFeatures	property exterior features if available
fee	hoa fee	“hoa-0”
fireplaces	number of fireplaces	“1”
first-photo	first property photo, this can go all the way up to 10 eg..([second-photo], [third_photo]) etc
first-photo-url	url for first property photo, this can go all the way up to 10 eg..([second-photo-url], [third_photo-url]) etc	“https://dvvjkgh94f244.cloudfront.net/1644840e/98844821/83dcefb7.jpeg”
flooring	flooring information	“Hardwood, Tile, Carpet”
foundation	foundation information
frequency	hoa frequency of payment	“hoa-”
full	full address	“2327 N Chimichanga Way”
garageSpaces	number of garage spaces	“3”
heating	heating information for property	“Electric, Forced Air”
highSchool	highs school name	“eagle”
id	id for property	“R5241420090”
interiorFeatures	interior feature information	“Bath-Master, Dual Vanities, Breakfast Bar”
internetAddressDisplay		“1”
internetEntireListingDisplay		“1”
lat	latitude coordinates of propery	“43.597867”
laundryFeatures	laundry info	“220v”
leaseTerm	lease information
leaseType	lease type informatiofn
listDate	listing date if available
listingId	listing id	“98846239”
listPrice	listing price	“475,000”
lng	longitude coordinates	“-116.214517”
lotDescription	information about lot	“1/2 – .99 AC, Auto Sprinkler System”
lotSize	lot size in dimensions	“370.35×116.4”
lotSizeArea	area of lot	“0.99”
lotSizeAreaUnits	units for lot measurement	“Acres”
maintenanceExpense	maintenance expenses information
marketArea	market area information	“Boise Bench – 0400”
middleSchool	middle school information	“Eagle Middle”
mlsId	mls id of propery	“180591371”
name	Hoa name	“hoa-”
occupantName	occupant name if available
occupantType	occupant type if available
office-brokerid	broker id for listing	“10170”
office-cell	broker cell phone number
office-email	broker email
office-name	broker name	“Silvercreek Realty Group”
office-phone	broker phone number	“208-555-5555”
office-servingName	broker name	“Silvercreek Realty Group”
originalEntryTimestamp	time stamp of mls entry
originalListPrice	original list price of property
originatingSystemName	name of mls property was listed	“IMLS 2”
ownerName	property owner name if available
ownership	ownership information	“Fee Simple,Fractional Ownership: No”
parking-description	description of parking	“Attached, Detached, Finished Driveway”
parking-leased	parking lease information
parking-spaces	number of parking spaces	“2”
photos	slideshow of photos
pool	pool information if available
postalCode	zip code for property	“83616”
privateRemarks	internal notes not meant to be viewed publicly
remarks	long note about property	“Charming Depot Bench Home with coved ceilings & arched doorways and original hardwood floors”
roof	roof information	“composition”
rooms	number of rooms
rooms-info	room information	“no rooms found”
school-district	returns school district
showingContactName	who to contact for showing
showingContactPhone	who to contact for showing
showingInstructions	instructions for showing
specialListingConditions	information about special listing conditions
sqftPrice	price per square foot	“337.02”
state	State initials of address	“ID”
status	listing status in MLS	“Active”
statusText	listing status in MLS	“Price Change”
stories	stories of property
streetName	street name of address	“N Chimichanga Way”
streetNumber	street number of address	“2327”
streetNumberText	street number of address	“2327”
style	style of House	“Victorian”
subdivision	subdivision name	“0 Not Applicable”
subType	type of subdivision	“SingleFamilyResidence”
taxAnnualAmount	annual amount of tax	“2242”
taxYear	last tax year	“2021”
type	type of property	“RES”
unit	unit number for address	“2c”
view	property view information
virtualTourUrl	url for virtual tour if available	“Virtual Tour”
water	water information for property
yearBuilt	year built of property	“1998”