API Overview

This page will soon contain the complete API documentation for our IDX Suite of products and will be updated frequently as new features are added.

Please note: The API functions described below are fully available in our retail IDX Suite of products.  If you have contracted IDXNW to create for you a custom IDX solution then it is possible the methods described below may differ or be unavailable in your specific situation and you are encouraged to contact support for more information.

Advanced Search API

If you are using the default "off the shelf" configuration of this IDX component (meaning that it has not been customized specifically for you), your site design and IFRAME must account for a width of 710 pixels.

A properly formatted simple URL to insert into an IFRAME for this component might look like:

http://search.idxnw.com/listings.html?id=123456789&s=1&type=resi


A properly formatted simple IFRAME tag to insert into your website's HTML code for this component, when using the 'cd=1' switch, might look like:

<IFRAME src="http://search.idxnw.com/listings.html?id=123456789&s=1&cd=1&type=resi" height="1750" width="710" frameborder="0" style="background-color: white; overflow: auto;"></IFRAME>


A properly formatted simple IFRAME tag to insert into your website's HTML code for this component, when not using the 'cd=1' switch, might look like:

<IFRAME src="http://search.idxnw.com/listings.html?id=123456789&s=1&type=resi" height="2500" width="710" frameborder="0" style="background-color: white;"></IFRAME>


Mandatory access switches:

id=[integer] [integer] = Your IDXNW system ID

Secondary access switches:

s=[integer] [integer] = Scope of search

0 = Only your listings or those of your office - (DEFAULT if switch is omitted or is any value other than 1)
1 = All active listings

page=[integer] [integer] = Jump to a page in the results
(DEFAULT is 1 if switch is omitted or lower than 1 and DEFAULT is highest page available if value is greater than maximum page number)

If the number entered is higher than the highest page in the result set, the system will move to the last page. If the number entered is lower than 1, the system will move to the first page.

type=[string] [string] = Starting property type to display
resi - Residential
cond - Condominium
mult - Multi-Family
vacl - Vacant Land
manu - Manufactured
farm - Farm/Ranch
rent - Rental
comi - Commercial
busi - Businesses

ns=[integer] [integer] = No search area at top of page - only functional when "s=1"

0 = Displays the search area - (DEFAULT if switch is omitted or is any value other than 1)
1 = Suppresses the search area

nt=[integer] [integer] = No tabbed property type navigation at top of page

0 = Displays the tabbed navigation
(DEFAULT if switch is omitted or is any value other than 1)
1 = Suppresses the tabbed navigation

cd=[integer] [integer] = Condensed display of property information, omitting the detailed listing data.

0 = Displays all information and photos
(DEFAULT if switch is omitted or is any value other than 1)
1 = Displays an abbreviated amount of listing information and only the primary photo

ps=[integer] [integer] = Page size
How many listings to display per page - Best used with "cd=1"

5 = Displays five listings per page
(DEFAULT if switch is omitted or is any value other than those listed)
10, 25, 50

nl=[integer] [integer] = No Login or Signup
Toggles 'Login or Signup' on the top of the page. Also disables the 'E-mail a friend' and 'Add to Favorites' as signup and login is required for those options.

0 = Allows signup and login
(DEFAULT if switch is omitted or is any value other than 1)
1 = Disables signup and login
mapshow=[integer] [integer] = Show Sliver Map Under Tabs
Forces the display of a 250-pixel tall map with markers for each property on that page.  Be sure to adjust your IFRAME height an additional 225 pixels to avoid the possibility of scroll bars on some pages.

1 = Enable Map
(Map not shown if switch is omitted or is any value other than 1)

Residential switches:
r1=[string] [string] = City
Constrain your search to specific cities/towns in Washington - separate each with a comma.

Example: r1=Seattle,Bellevue,Mercer Island,Kirkland

r2=[string] [string] = County
Constrain your search to specific counties in Washington - separate each with a comma.

Example: r2=King,Snohomish,Pierce

r3=[string] [string] = Zip Code
Constrain your search to specific zip codes in Washington - separate each with a comma.

Example: r3=98102,98103,98012,98188

r4=[integer] [integer] = Lowest Price
The lowest price with which to constrain your search. Whole numbers only - no dollar sign, commas, or decimals.

Example: r4=125000

r5=[integer] [integer] = Highest Price
The highest price with which to constrain your search. Whole numbers only - no dollar sign, commas, or decimals.

Example: r5=375000

r9=[integer] [integer] = Bedrooms
The lowest number of bedrooms with which to constrain your search. Whole numbers only.

Example: r9=3

r10=[number] [number] = Bathrooms - A value between 1 and 5
(DEFAULT: ignored if value is omitted, value is 0, value is out of range, or value is not in the format below)
Values are in the format of:

1 = One full bathroom
1.25 = One and a quarter bathrooms
1.5 = One and a half bathrooms
1.75 = One and three-quarter bathrooms
and so on... up to '5'

Example: r10=2.5

r13=[string] [string] = Sort Results By - A value that lets you set the options available in the "SORT RESULTS BY:" drop down and filter results by things like "Short Sales Only", "Bank Owned/REO Only", or "Houseboats Only".
(DEFAULT: "plowhigh" if value is omitted)

Values are in the format of:

"plowhigh" = Price: Low to High
"phighlow" = Price: High to Low
"dlowhigh" = Days: Newest First
"dhighlow" = Days: Oldest First
"lastone" = Days: Last 24 Hours
"openonly" = Open Houses Only
"onlywf" = Waterfront Only
"onlyhb" = Houseboats Only
"onlyss" = Short Sales Only
"onlybo" = Bank Owned/REO Only
"onlygreen" = Green Built Only
"onlynew" = New Construction Only
"notboss" = NOT Bank Owned/Short Sale
"onlyus" = This Office Only (Only for clients of office-level service)
"onlyme" = This Broker Only (Only for clients of individual broker-level service)
"lasttwo" = Days: Last 2 Days
"lastthree" = Days: Last 3 Days
"lastseven" = Days: Last 7 Days
"lastmonth" = Days: Last Month
"overone" = Days: Over 1 Month
"overthree" = Days: Over 3 Months
"oversix" = Days: Over 6 Months
"overyear" = Days: Over 1 Year

Example: r13=onlyss

Condominium switches:

Condominium switches use the same format as residential, but begin with the letter "c" and then the switch type number. The equivalent of the r1 switch for condominioums would be c1, and so on.

Multi-Family switches:

Multi-family switches use the same format as residential, but begin with the letter "m" and then the switch type number. The equivalent of the r1 switch for multi-family would be m1, and so on.

Vacant Land switches:

Vacant land switches use the same format as residential, but begin with the letter "v" and then the switch type number. The equivalent of the r1 switch for vacant land would be v1, and so on.

Manufactured switches:

Manufactured switches use the same format as residential, but begin with the letter "t" and then the switch type number. The equivalent of the r1 switch for manufactured would be t1, and so on.

Farm/Ranch switches:

Farm/ranch switches use the same format as residential, but begin with the letter "f" and then the switch type number. The equivalent of the r1 switch for farm/ranch would be f1, and so on.

Rental switches:

Rental switches use the same format as residential, but begin with the letter "j" and then the switch type number. The equivalent of the r1 switch for rental would be j1, and so on.

Commercial switches:

Commercial switches use the same format as residential, but begin with the letter "i" and then the switch type number. The equivalent of the r1 switch for commercial would be i1, and so on.

Businesses switches:

Business switches use the same format as residential, but begin with the letter "b" and then the switch type number. The equivalent of the r1 switch for business would be b1, and so on.

Map Search API

If you are using the default "off the shelf" configuration of this IDX component (meaning that it has not been customized specifically for you), your site design and IFRAME can be of virtually any height and width you desire as the map dynamically resizes itself to the dimensions of the IFRAME that contains it. We recommend a width of '100%' and a height of '600' as a starting point and then you can modify to your specifications from there.


A properly formatted simple URL to insert into an IFRAME for this component might look like:

http://search.idxnw.com/mapsearch.html?id=123456789&city=seattle


A properly formatted simple IFRAME tag to insert into your website's HTML code for this component might look like:

<IFRAME src="http://search.idxnw.com/mapsearch.html?id=123456789&city=seattle" height="600" width="100%" frameborder="0" style="background-color: white; overflow: auto;"></IFRAME>


Mandatory switches:

id=[integer] [integer] = Your IDXNW system ID

Secondary access switches:

city=[string] Starting City
All officially recognized cities and towns in Washington are in our database, however if you find you need an additional entry added simply send us an e-mail.

(DEFAULT is Seattle if switch is omitted or is any city not in our database - we recommend this this option always be explicitly set to avoid the possibility of future complications)

sp=[string] Sidebar and Controls Position
Determines the position of the map's results sidebar and search controls.

(DEFAULT: R if switch is omitted or is any value other than L, R, T, or B)

R = Right
L = Left
T = Top
B = Bottom

nl=[integer] No Login or Signup
Toggles 'Login or Signup' on the top of the page. Also disables the 'E-mail a friend' and 'Add to Favorites' as signup and login is required for those options.

(DEFAULT if switch is omitted or is any value other than 1)

0 = Allows signup and login
1 = Disables signup and login

pl=[integer] Price lowest
No currency symbol, commas or decimal point allowed.

(DEFAULT: 0 if switch is omitted or is any value other than an integer)

ph=[integer] Price highest
No currency symbol, commas or decimal point allowed.

(DEFAULT: 99999999 if switch is omitted or is any value other than an integer)

bed=[integer] Bedrooms
A value between 0 and 8.

(DEFAULT: is ignored if switch is omitted or value is out of range)

bath=[number] Bathrooms
A value between 1 and 5

(DEFAULT: is ignored if value is omitted, value is 0, value is out of range, or value is not in the format below)

Values are in the format of:

1 = One full bathroom
1.25 = One and a quarter bathrooms
1.50 = One and a half bathrooms
1.75 = One and three-quarter bathrooms
and so on... up to '5'

sort=[string] Sort Results By
A string value as shown below that will include or exclude certain property results returned as a result of the other filters.

(DEFAULT: 'plowhigh' if value is omitted or value is not in the format below)

Values are in the format of:

plowhigh = Price low to high
phighlow = Price high to low
dlowhigh = Days on Site low to high
dhighlow = Days on Site high to low
lastone = New in last day
lasttwo = New in last two days
lastthree = New in last three days
lastseven = New in last week
lastmonth = new in last month
overone = Only listings over one month
overthree = Only listings over three months
oversix = Only listings over six months
overyear = Only listings over one year
onlyus = Only listings that belong to your office or as a co-office listing
onlyme = Only listings where you the listing or co-listing agent


z=[integer] Map Zoom Level - Force the map to a specific zoom level
A value between 8 and 19 where 19 is the highest magnification.

(DEFAULT: is ignored if switch is omitted or value is out of range)

lat=[float] Map Latitude - Force the map to center on a specific latitude
A value between -90.0 and 90.0

(DEFAULT: is ignored if switch is omitted, value is out of range or there is no corrisponding value for the MAPLONG switch)

long=[float] Map Longitude - Force the map to center on a specific longitude
A value between -180.0 and 180.0

(DEFAULT: is ignored if switch is omitted, value is out of range or there is no corresponding value for the MAPLAT switch)

resicheck=[integer]
condcheck=[integer]
multcheck=[integer]
vaclcheck=[integer]
rentcheck=[integer]
manucheck=[integer]
farmcheck=[integer]
comicheck=[integer]
busocheck=[integer]
Map Pre-Checked Property Types - Force the map to launch with certain property types pre-checked or pre-unchecked
A value of 1 to check or 0 to uncheck

(DEFAULT: only residential will be pre-checked if switch is omitted or value is out of range)

For this feature to function, you *MUST* explicitly set each of the nine property types with a value of 0 or 1 (not blank) or they will all be ignored.