=== SimplyRETS === Author: SimplyRETS Contributors: SimplyRETS Tags: rets, idx, real estate listings, real estate, listings, rets listings, simply rets, realtor, rets feed, idx feed Requires at least: 3.0.1 Tested up to: 4.3.1 Stable tag: 1.6.2 License: GPLv3 License URI: http://www.gnu.org/licenses/gpl-3.0.html Show your Real Estate listings on your Wordpress site. SimplyRETS provides a very simple set up and full control over your listings. == Description == = Getting Started = SimplyRETS allows you to display and search your Real Estate listings directly on your Wordpress site. And it call be set up in less than 5 minutes! The SimplyRETS Plugin has the most filtering options of any IDX Plugin on the market, with over 25 different ways to create unique pages of listings on your site. No iframes, great SEO, and a modern and customizable interface for a modern Real Estate Agent. To get *your* listings showing through the plugin, you need 3 things: * [Create an account with SimplyRETS](https://simplyrets.com/account) * Use the RETS credentials from your MLS to [create an app](https://simplyrets.com/blog/getting-set-up.html). * Start getting LIVE listings right on your site! **To get started, check out the [Documentation page](https://wordpress.org/plugins/simply-rets/other_notes/)** **[Visit our website](https://simplyrets.com)** = The 5 Minute Setup = [youtube https://www.youtube.com/watch?v=hh-YJYyhxv0] = Using the Test Listings = To use the free trial listings, all you need to do is install it and start creating pages! The test credentials are already saved in the plugin when you install it, so you can spend more time making an awesome real estate website. = Features & Documentation = To use the available widgets, and short-codes - start by reading over [the Documentation page](https://wordpress.org/plugins/simply-rets/other_notes/). The [GitHub README](https://github.com/rbros/simplyretswp) also provides a good starting point for developers looking to customize some features. As always, you can email [support@simplyrets.com](mailto:support@simplyrets.com) for any questions you can't find an answer to! = How it Works = The SimplyRETS plugin generates accurate and correct HTML and does *not* use iframes or ever take your visitors away from your site - which we've learned is essential for materializing online leads. The power is put back in your hands by giving you full control of which of your listings to show, and on which pages. The plugin also provides you extensions on many standard Wordpress features: * A robust set of shortcodes and attributes to build virtually any type of page you can imagine. * A custom 'SimplyRETS Listings' page type for creating pages with listing results. * Sidebar and footer widgets for Featured Listings, Search, etc. * Plenty of short-codes for splicing your listings into any page or post. * Filters for searches, custom pages, etc. SimplyRETS provides the fastest and most up-to-date solution for embedding your listings on your site. SimplyRETS will update as frequently as every hour (or as frequent as your MLS provider allows). This means that you're ahead of the competition and can have the fastest possible response time for dealing with interested prospects. This plugin is fast!. You don't have to worry about slowing down your website by pulling lots of data on every page load. The SimplyRETS plugin is optimized to only load on the correct pages, and to only load the listings you choose. By doing this, you are able to keep visitors on your site to look at more properties. If you offer the fastest searching solution in your city, why would they go any where else? SimplyRETS uses the RETS (Real Estate Standards Organization) protocol and has 100% coverage and compatibility with the RETS standard. This allows you to be on the leading technical edge and provides you with many advantages of IDX (internet data exchange) including response speed, compatibility across multiple MLS areas, and up-time. So while your competition is working on getting properties on their site, you can install the SimplyRETS Wordpress plugin and spend more time actually selling! == Installation == You can simply install this plugin a couple of different ways: = Wordpress Plugin Directory = 1. If you usually install plugins via the Wordpress Dashboard 'Add Plugins' page, you can just search for 'SimplyRETS' and click install! = Install from the .zip: = 1. Download the `.zip` file 1. In your Wordpress dashboard, go to `Plugins -> Add New`. Choose `Upload a New Plugin` and upload the `.zip` file. = Manual install from .zip: = 1. Download the `.zip` file and extract it into your sites `wp-content/plugins` directory 1. Be sure to extract it into a directory called `wp-content/plugins/simply-rets/`. = Activating = Once you have the plugin installed via one of the methods above, you can go to the Plugins page of your Wordpress site and click `activate` on SimplyRETS. Once successfully activated, you can start using the demo listings, or enter your SimplyRETS credentials to start getting your listings! == Frequently Asked Questions == = Can I use this plugin for free? = Yes! The SimplyRETS Wordpress plugin comes with free demo listings that you can use on your site. Mostly, this should be used for testing the plugin to make sure it fits your needs. To show *your* listings on your site, you will need an active plan with [SimplyRETS](https://simplyrets.com). = Can I use my existing Wordpress theme? = Yes! The SimplyRETS plugin generates widely compatible and responsive HTML for your pages. It has tested on and made to work with many different types of Wordpress themes. If you find a theme that this plugin does not work with, let us know! The plugin does *not* use iframes, but generates and embeds the HTML directly on your site, which means that your visitors get the best experience possible when browsing your listings. = Is it possible to use my own CSS or change the styling? = Absolutely! The plugin comes with very versatile CSS, but you may want to add your own style and personal touch to it. We've created a very simple set of CSS classes and ID's for you to use to change the styles. You can start by installing one of the many custom CSS Wordpress plugins, or if you're using a Child Theme, you can put it directly in your child-custom.css/style.css. You can find the SimplyRETS Style Documentation in the Documentation section of the website: [SimplyRETS Style Documentation](https://docs.simplyrets.com). = How do I show *my* listings through this plugin? = Once you've decided that the plugin does what you need it to do, you can contact us at [the SimplyRETS website](https://simplyrets.com#home-contact). We'll get you signed up and provide you with an API username and password. Starting to use your real listings is as easy as plugging the API credentials into the Wordpress Admin settings page (`Settings -> SimplyRETS`) and hitting save! If the credentials are valid, your listings will start to show automatically. If they are invalid, the test data will continue to be used. = How often are the listings refreshed? = SimplyRETS will keep the most up to date listings on your site. We will refresh on average every 2 hours. = Do I have to be signed up with an MLS provider? = Yes. In order for the plugin to show your listings, you first need to get a RETS feed set up with your MLS provider. = I want to only show my listings, and not my whole office. Is that possible? = The SimplyRETS plugins provides 'filters' for all the listings on your site. For example, if you create a new SimplyRETS page, you can add an Agent Filter on that page which will take your Agent MLS Id. Then when that page is loaded, only listings tied to that Agent MLS Id will be shown. = How long can I use the test data? = You can use the test data for as long as you need! The only restriction for the test data is that you must make less than 1,000 requests a day. Other than that, keep in mind that the test data listings are *not* real properties, but it does provide the same fields that we will get from your MLS provider. == Screenshots == 1. SimplyRETS settings page for entering API credentials 2. The SimplyRETS custom page type creation pages. Here you can show different types of listings with the available 'page filters' and add any short codes, like a search form. 3. A client side page with multiple listing results embedded. 4. A single listing details page complete with an image gallery, contact button, and sidebar widget. 5. The SimplyRETS Featured Listing sidebar widget in action. (default 2015 theme) 6. This screenshot shows the search form short-code and a featured listing sidebar widget. 7. The SimplyRETS Listings Slider == Changelog == = 1.6.2 = * FIX: Update deprecated WP_Widget Contructors to prevent warnings/fix build * UPDATE: Update wp-cli bash script to fix Travis build. * UPDATE: Move "Listing Meta Data" information into "MLS Information" section on single listings. = 1.6.1 = * FEATURE: Support for new fields provided by the SimplyRETS API * FEATURE: Ability to create a demo page from Settings page and Activation Message. = 1.6.0 = * FEATURE: Allow multiple agent ids in the [sr_residential] shortcode * FEATURE: Allow multiple property types the [sr_residential] shortcode = 1.5.12 = * IMPROVEMENT: Refaactor away some inline CSS * IMPROVEMENT: If agent name is not available, show their ID. * PATH: Fix pagination when using the 'water' parameter = 1.5.11 = * FEATURE: Add "water" features to details page when available = 1.5.10 = * FEATURE: Allow setting map position on a per shortcode basis = 1.5.9 = * FEATURE: Admin option for setting lead capture email recipient = 1.5.8 = * FEATURE: Add setting for lead capture recipient. You can choose who email get sent to * NEW: Allow agents and limit parameters in the sr_searh_form shortcode * UPDATE: More generic text in on the search results = 1.5.7 = * UPDATE: For additional room details, use dimensions instead of length and width (if available) = 1.5.6 = * FEATURE: Add support for showing extended room details (in areas where it is available) = 1.5.5 = * PATCH: Use better query parameters in the sidebar search widget = 1.5.4 = * PATCH: Small patch to fix pagination links when using sr_keywords searches = 1.5.3 = * IMPROVE: Improve pagination parser * FIX: Fix specifying multple cities and a vendor in a single shortcode = 1.5.2 = * Improve a bunch of the documentation, add more examples, etc = 1.5.1 = * IMPROVEMENT: Allow vendor parameter in single listing short-code * FIX: SimplyRETS Lead Capture MLS ID field = 1.5.0 = * NEW: Support for all features when using a Multi-MLS feed * NEW: "Random" options for the sr_listings slider * IMPROVEMENT: Improve persisting of search parameters when paginating * IMPROVEMENT: Better error messages * IMPROVEMENT: Code cleanup * FIX: SimplyRETS Lead Capture MLS ID field = 1.4.3 = * NEW: Add data-attribute tag to each row on listing details pages to allow for easier targeting when adding custom CSS or JS (Thanks to Chris Howard for the patch). * FIX: Fix for pagination links when using the brokers filter * FIX: Use full name for agents (concat first and last name) = 1.4.2 = * Fix for SrShortcodes class declaration error = 1.4.1 = * NEW FEATURE: Featured Listings Slider [sr_listings_slider] * Sort advanced search form fields alphabetically * CSS fix for basic search form = 1.4.0 = * NEW FEATURE: Advanced search form for all MLS's! * NEW FEATURE: Option to sort search results by price and date. * Add support for commercial, land, multi-family, and farm property type (must be enabled in your SimplyRETS account) * New Shortcode [sr_listings] as an alias to [sr_residential] * Ability to update meta data from the admin panel * Better handling of fields shown for listings in search results * Minor bug fixes and patches = 1.3.4 = * NEW FEATURE: For showing single listing and searches on a map view! * Changed Fancy Gallery to not stretch small images * Minor bug fixes and patches = 1.3.3 = * Added initial, basic support for Listhub Analytics! * Show ListingId (MLS #) instead of unique ID in listing details * Better responsive CSS for search form and search results * Added support for using multiple neighborhoods/cities/zipcodes in the sr_residential shortcode * Added new Agents Listings Widget for showing listings for a specific agent * Clean up for existing widgets = 1.3.2 = * Patches for URL encoding spaces and hash symbols * Patches for area/sqft units in markup = 1.3.1 = * FEATURE: Single Listing Contact Form Lead Capture * Patches for pagination links * SSL! * Better support for showing/hiding fields based on availability * Other minor patches = 1.3.0 = * New Image Gallery Option! With full screen and thumbnails * Add option to show/hide listing description (remarks) * Better handling of fields that may or may not be present * other fixes and improvements = 1.2.0 = * Add graphical shortcode/page builder got creating listing shortcodes * Add support for listing limit and pagination for multiple pages of listings * Add support for agent ID query parameter in shortcode & custom post type * Add more styling and clean up text in admin settings panel * better error handling * other fixes and improvements = 1.1.5 = * Automatically save test credentials when plugin is activated to make it easier to get started. = 1.1.4 = * Add option for hiding Listing Date and Listing Last Modified fields = 1.1.3 = * Fixes php warning on new SimplyRETS Pages * Other fixes to prevent errors and warnings * Added testing suite!! = 1.1.2 = * Patch for search results or shortcode with a single listing response = 1.1.1 = * Better handling of data fields that might not always have a value * Fix for search results with only one result = 1.1.0 = * Add a new Search Form sidebar/footer Widget * Add a new Random listing widget * Implement Contact Page link setting for linking to the sites contact page from single properties * improve keyword search * improve error handling * improvements and bug fixes to admin panel and settings * Add better default property image for listings with no images * search form min/max inputs are number boxes now * Grammar/text fixes and improvements * Improve API authentication and set up content versions for stability (using cURL) = 1.0.3 = * patched php optional warning argument = 1.0.2 = * enhance default markup and css to be compatible with a wider range of themes = 1.0.1 = * Better image cdn link handling = 1.0.0 = * Initial Launch == Upgrade Notice == = 1.3.3 = * If you are building any shortcodes, links, or widgets from the MLS ID - you should double check that with this update they are still showing the correct listing - we switched to the MLS# instead of internal uid. = 1.3.0 = * This update will move you to the new Fancy gallery - If you like the Classic gallery, you can switch it back in Settings -> SimplyRETS (no changes to Classic gallery) = 1.2.0 = * This update should fully support backwards compatibility, but if you notice problem update to the latest version. = 1.1.3 = * This update fixes a visible warning on new SimplyRETS post pages = 1.1.0 = * There are many new updates and features added to this release. A lot of the API authentication has improved, so old clients need to be updated. See the Changelog for a complete list. = 1.0.3 = * If you were experiencing any error outputs on your site (mostly GoDadddy host), this update will resolve the issue. = 1.0.0 = * Launch == Documentation == The SimplyRETS plugin makes it easy an intuitive to show your listings on your site in a way that *you* want. There's virtually no restrictions to how you can customize the plugin and your site. The plugin is based around shortcodes; there are shortcodes for listings, search forms, sliders, and more. Each of these shortcodes takes attributes that refine which listings are pulled. For example: To show all listings from your MLS: `[sr_listings]` but to only show listings from a specific agent: `[sr_listings agent="AGENTID"]` ..read more about the available attributes [here][shortcode attributes]. == Contents == - Shortcodes - Listings - Search Form - Listing Slider - Available attributes - Widgets - Test Listings - SimplyRETS Pages - Custom CSS - Support / More Documentation == Shortcodes == Most of the plugin is built around using shortcodes. This allows the most flexibility for customizing your own layout and search pages. = SimplyRETS Listings Shortcode = `[sr_listings]` This is the main shortcode for showing listings on any page of your site. Put this shortcode onto any page and, voila, you've got listings! This shortcode takes many different [attributes][shortcodes attributes], and you can combine almost any of them. If you want to use the listings shortcode, but only show listings above $500,000 then you would simply add the `minprice` attribute: `[sr_listings minprice="500000"]` So how about the same minimum price, but only for one specific agent? Easy! `[sr_listings minprice="500000" agent="ID"]` (*Note: the ID is provided by your MLS*) = SimplyRETS Search Form Shortcode = `[sr_search_form]` Next up is the search form shortcode. This is what ties together the ability to search and view listings. This shortcode also takes a few different attributes, but not quite as many as the listings shortcode because the user will change them. For example, you can set up a search form that will only search form that will always search one specific office or brokerage: `[sr_search_form brokers="ID"]` (*Note: the ID is provided by your MLS*) There are several use-cases for the search form and you can put it anywhere on your site you want! The two most common ways to use the search form are: 1. On the landing area of your homepage, to get the visitor to start a search immediately. 1. To be used in combination with the listings shortcode, like so: `[sr_search_form]` `[sr_listings]` This builds a nice page with an initial set of listings, which promotes the visitor to continue making a search. = Listings Slider Shortcode = `[sr_listings_slider]` The listing slider is a great feature that allows you to build a 'slider' of listings. See [screenshot #7](https://wordpress.org/plugins/simply-rets/screenshots/) for a quick glance of how it works. The slider shortcode takes all the same attributes as the listings shortcode, which is all of them. So to make a slider with listings over $500,000: `[sr_listings_slider minprice="500000"]` And the same minimum price, but only for one specific agent? Easy! `[sr_listings_slider minprice="500000" agent="ID"]` (*Note: the ID is provided by your MLS*) = Available Attributes = There are ton of attributes available for refining the listings in any way you can imagine. Each of these attributes can be used in any of the shortcodes, and you can use (most of) them in combination with each other like the examples above: * **mlsid** Fetches a single listing by it's mlsid. `[sr_listings mlsid="12345"]` * **status** Refines listings by a certain status, like Active, Pending, or Closed. `[sr_listings status="Closed"]` * **minprice** Refines listings to a minimum price. `[sr_listings minprice="500000"]` * **maxprice** Refines listings to a maximum price. `[sr_listings maxprice="1000000"]` * **minbeds** Set a minimum amount of bedrooms. `[sr_listings minbeds="3"]` * **maxbeds** Set a maximum amount of bedrooms. `[sr_listings maxbeds="3"]` * **minbaths** Set a minimum amount of baths. `[sr_listings minbaths="3"]` * **maxbaths** Set a maximum amount of baths. `[sr_listings maxbaths="3"]` * **q** A fuzzy keyword search that will include listings matching a given string. `[sr_listings q="great view"]` * **type** Refines listings by a certain type, like Residential, Condo, Rental. `[sr_listings type="Rental"]` * **agent** Refines listings to a specific agent by taking an agent's MLS ID. `[sr_listings agent="JDOE12"]` * **brokers** Refines listings to a specific brokerage by taking a brokerage's MLS ID. `[sr_listings brokers="KWREALTY1"]` * **lotsize** Refines listings by a certain lot size in Sq Ft (note, this is not area). `[sr_listings lotsize="5000"]` * **area** Refines listings by a certain area size in Sq Ft. `[sr_listings area="1500"]` * **cities** Refines listings to a given set of cities. (Separate multiple with a semi-colon). `[sr_listings cities="Houston; Austin; Dallas"]` * **neighborhoods** Refines listings to a given set of neighborhoods/subdivisions. (Separate multiple with a semi-colon). `[sr_listings cities="Heights; Downtown; Uptown"]` * **amenities** Refines listings to a given set of amenities. (Separate multiple with a semi-colon). `[sr_listings cities="Granite; Balcony"]` * **features** Refines listings to a given set of features. (Separate multiple with a semi-colon). `[sr_listings cities="Tennis Court; Waterfront"]` * **vendor** Refines listings by a certain vendor or MLS Board. (This is only available when your account has multiple MLS's). `[sr_listings vendor="MFRMLS"]` * **limit** The amount of listings to return. Default is 20, maximum is 50. `[sr_listings limit="50"]` * **offset** Returns a set of listings and skips the first *n*, where *n* is the offset. `[sr_listings offset="20"]` * **sort** Displays the listings in a specific order. `[sr_listings sort="price"]` (The available sort options are `listprice`, `-listprice`, `listdate`, `-listdate`, `baths`, `-baths`, `beds`, and `-beds`. Options starting the a minus (-) are high to low, no minus sign is low to high). * **advanced** This attribute is to turn the basic search form into an advanced search form. `[sr_search_form advanced="true"]` == SimplyRETS Widgets == The SimplyRETS plugin comes with several widgets you can use in you sidebar and footer. The currently available widgets include: * **Search Form Widget** The search form widget allows you to add an MLS search in the sidebar or footer of your site. * **Featured Listing Widget** This takes one listing MLS id, and will embed the property in a widget with a link to the details page of that property * **Random Listing Widget** This is similar to the Featured Listing Widget, but takes multiple MLS Id's. On each page load, it will show one of the listings provided. * **Agents Listing Widget** The search form widget allows you to add an MLS search in the sidebar or footer of your site. == Trial Listings == You can use the Trial Listings as much as you need before you set up your own. They only contain a subset of the options that are available from most MLS's, but there is plenty to work with! Here's how to get hem set up: * Navigate to the SimplyRETS Settings page in your Wordpress dashboard `Settings -> SimplyRETS` * Insert the testing API Keys (Username: simplyrets Password: simplyrets) The trial listings are activated automatically - so if you're installing the plugin for the first time, you don't need to do the above steps. == SimplyRETS Pages == SimplyRETS pages allow for an easy way to get up and running with new pages. Here's a few tips: * To create a new page, navigate to `SimplyRETS -> Add New Page` in your Wordpress dashboard. (by default these pages will show all of your listings - 25 per page). Name it, publish it, and you're done! * You can add filters to this page by editing the post and using the **Filter Results on this Page** options. * You can add filters for price, agent, min/max bed, min/max bath and more. * SimplyRETS Pages give you the ability to choose from your theme's available templates. *Note*: it is usually recommended to use the shortcodes directly since they give you much more control and options, however if you're a theme developer then customizing the SimplyRETS pages may be the best option. == Customizing the CSS == We're are totally OK with you tweaking the CSS and changing it to fit your needs. As a matter of fact, we want you to! If you need to add any custom styling you can add custom CSS using our Style Guide. The Style Guide will show you which classes and id's to use to when adding your own css. You can find it here: [SimplyRETS Style Guide](https://docs.simplyrets.com/simply-rets-client.html) == Support, Contributing, and More Information == We want to hear from you! Whether you're an agent or developer, need help getting set up, or want to contribute some code - come one come all. = Feature Request? = If you have a suggestion for a new feature to add to the plugin, let us know! We're always looking to expand our plugin to give you what you need to make the best possible site. Email support@simplyrets.com if you have an idea, we'd love to hear it! = For Agents = Need help finding a developer to build the best Real Estate site in town (that people will actually use)? Shoot us an email and we can help hook you up with some of the amazing developers that are pro's at using the SimplyRETS product suite: support@simplyrets.com = For Developers = If you're interested in building your own Plugin or Application, SimplyRETS offers several different API's specifically geared towards developers. We provide a JSON API's to access the same data you see in this plugin, as well as other services like Database population and analytics, and geocoding. The API's are simple, and the documentation is robust. Try it out and let us know what you think. Visit the SimplyRETS website for more details and a full list of services: [SimplyRETS Features](https://simplyrets.com/services) There is more documentation for both the SimplyRETS API, and the SimplyRETS Wordpress plugin. You can dig into all of that on the SimplyRETS Docs website: [SimplyRETS Documentation](https://docs.simplyrets.com)