Idx Package Usage - Sitetheory/stratus GitHub Wiki

Home / Packages / Idx / Usage

Table of Contents

Idx Widget Usage

We recommend appending `data-` to any Stratus HTML data attributes to be most compatible with all browsers. e.g.: ng-model='model' could be written as data-ng-model='model'. For shorthand and readability sake, we will omit appending this from data attributes in this informational.

All widgets are actively under heavy development and options/usages are subject to possible changes.

Usage

Variables

Query Options

Parameter Type Default Description
order string The order in which results will be displayed based on Field. Such as '-ListPrice' would list the Field 'ListPrice' in reverse, being the highest number first.
page number 1 The page number of load.
perPage number 25 The number of results to display per page.
images boolean
json 
{limit:1}
 The query of images that is allowed to be provided. Allows limiting how many images to display to reduce bandwidth and decrease load times
service number[] Which service id's fetch a token/perform queries for. As this this a request for access, what tokens are actually returned is up to the digression of the url/provider. At the time of this writing, Gutensite and Sitetheory offer Idx Services with these values:
  • 0: Internal Listings
  • 1: MLS Listings Inc
  • 2: SFARMLS
  • 3: BAREIS
  • 7: Hawaii Information Services
  • 8: CCAR
  • 9: bridgeMLS
  • 10: HAR

Value example: 
[0, 2] // Internal Listings and SFARMLS
where json Raw Results querying. Generally, each field can be searched, such as 'City', 'Status', 'ListingType', ect.
See See Where Query below

Where Query

Commonly used parameters for Where (all being optional):

Parameter Type Description
MlsStatus string[] Current listing status.
Possible options include:
  • Active
  • Contract (Pending or Contingent variations)
  • Closed (Off Market/Sold/Leased)
Defaults to: 
['Active']
ListPriceMin number Listings put On Market at this last price minimum.
ListPriceMax number Listings put On Market at this last price maximum.
Bedrooms number Listings with this number of Bedrooms minimum.
Bathrooms number Listings with this number of total Bathrooms minimum.
ListingType string[] Type of listings to display
Possible options include (can vary between MLS'):
  • House
  • Condo
  • Townhouse
  • Multi-Family
  • Manufactured
  • Land
  • Other
  • Commercial
  • Commercial Business Op
  • Commercial Residential
  • Commercial Land
Defaults to: 
['House', 'Condo', 'Townhouse']
AgentLicense string[] Listings with Listing/Buyer (or Co Listing/Buyer) Agent.
May not yet be available to certain MLS' that do not provide the State License on Listings.
Example: 
['001234567']
OfficeNumber string[] Listings with Listing/Buyer (or Co Listing/Buyer) Office.
May not yet be available to certain MLS' that do not provide the State License on Listings.
Example: 
['12345']
⚠️ **GitHub.com Fallback** ⚠️