We now also have Widget Code Generators for current customers! Just sign in at the top-right and click on the IDX Search option in the top menu. At the bottom of that page you can find these new options. Schweet!
ListingWare API Video: 1 hour, 18 minutes; 130 MB: Goes in-depth on the API and how you can customize your service with it. Shows older version of our website and our service, but all API info is the same. There is one hitch with Skype toward the end that shows they still had some privacy bugs, so please forgive that. Requires GoToMeeting Codec.

Because You Asked For It…

We have created the ListingWare Application Programming Interface (API).Â With it, you can create your own custom searches, listing displays, or links directly with ListingWare.

Where To Start?

Everything is built on your base URL – the web address that identifies your unique account. It is in theÂ form of:

1

2

http://membername.servicename.com/search/

(you received thiswhen the account was created)

If you’re using our Complete Website option and have a domain name assigned on your account, you could use:

1

2

http://www.yourname.com/search/

(thisisonly ifWE are hosting your website/domain name here)

This is what you use to call the basic search according to how you’ve configured it in the Account Manager under IDX Search > Search Style.

What’s Next?

Next, you add the particular page name that you’re trying to access, which would be one of four pages:

1

2

3

4

index.cfm(starting criteria page)

map.cfm(map search page)

searchresults.cfm(standard thumbnail view page)

searchdetail.cfm(only forindividual listing display)

And Then…

After the page name, you add a question mark, followed by the query string/URL parameters, each separated by the ampersand sign (&):

1

?Parameter1=XXXX&amp;Parameter2=YYYY&amp;Parameter3=ZZZZ

Now, The Good Stuff…

Here are the various parameters you can put into the query string. All parameters are optional.

For parameters with SPACES, such as city names, replace spaces with a plus sign (+). Example: ‘East Point’ becomes ‘East+Point’.Added 6/28/11: You can also replace spaces with underscores (_). Example: ‘East Point’ becomes ‘East_Point’. This works better for WordPress integration.

For parameters with APOSTROPHES, such as subdivisions, replace single apostrophes with two consecutive apostrophes (”). Example: O’Dell’s Run becomes O”Dell”s Run. Make sure that you use two apostrophes, NOT the double quote symbol.

1, 2, 5, or 6(Without DynaMap, 1 is only valid value;
5 and 6 not available with Classic version)

1

ResultsStyle=1
ResultsStyle=2

Special Parameter: LeadSource

There is an additional parameter available for tracking where Leads come from called LeadSource.This can be used to differentiate separate implementations of your central URL. If you’ve got more than one website where your URL is plugged in, you can track it! For example:

With this, you’ll be able to track the effectiveness of ALL of your IDX implementations!

Special Note: The Evils of ‘Copy and Paste’ (Updated 2/18/10)

As you use the API, you may also encounter some additional URL parameters – either CFID/CFToken or JSessionID. These are two special variables related to ColdFusion, which is the web application language used to create ListingWare. Previously, you could cause issues with visitor tracking and registration if you included these in your links. This shouldn’t be a problem any longer, as we’ve stopped using them in our links automatically. You may have created links in the past that have them embedded, but it shouldn’t be a problem. However, it’s good practice to remove them if you encounter them.

API Examples

You can use these parameters to either create custom searches that appear at the click of a button or link, or tailor the starting search page so that certain parameters are pre-selected. These examples work with any of our versions. Try them with your own URL – just substitute yours where it has http://yourname.servicename.com below. But make sure you check out all of the parameters you can use to get the most out of the API!

To provide different starting search parameters, start with the index.cfm page.