Search listings
simplyrets_search_listingsSearch MLS listings (SimplyRETS /properties): by keyword, status, type, price, beds, baths, area, year, city, zip, neighborhood, agent, broker, features or a map polygon. Returns address, price, status, photos, agent, office, property details and remarks, without empty fields. Pass count=true to get the total. Page with next.offset or next.lastId. GET /properties.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Keyword search over MLS number, street, unit, city, postal code, subdivision and area; several values match any. | |
| idx | No | IDX display filter. Default 'null' hides listings whose address or entire listing may not be displayed online; 'ignore' returns them too. Your MLS's display rules still bind how you use the data. | |
| pool | No | Pool: 'true', 'false' or a value such as 'Private'. | |
| sort | No | Sort field; a leading minus is descending. Ignored with lastId. | |
| type | No | Property type (default residential and rental). | |
| agent | No | Listing agent MLS ids (the co-listing agent is not matched). | |
| count | No | Also return the total number of matches (slower on big feeds). | |
| limit | No | Results per page, 1-100 (default 10). | |
| state | No | State or province (case-insensitive). | |
| water | No | Water body: 'true', 'false' or a value. | |
| cities | No | Cities (case-insensitive). simplyrets_get_feed_metadata lists the cities in the feed. | |
| lastId | No | Cursor: 0 for the first page, then the previous reply's next.lastId (sort is ignored when set). | |
| maxdom | No | Maximum days on market (needs Days on Market data in the feed). | |
| offset | No | Records to skip (the previous reply's next.offset). Do not combine with lastId. | |
| points | No | A polygon of 'lat,lng' points (3 or more); returns listings inside it. Needs latitude/longitude in the feed. | |
| status | No | Listing status (default Active). Closed = sold or leased. | |
| vendor | No | MLS vendor id; required on multi-MLS apps (simplyrets_get_account_info lists them). | |
| brokers | No | Broker or listing office ids, as your MLS provides them. | |
| include | No | Extra fields: compliance (IDX display data) and rooms (when the feed has them). | |
| maxarea | No | Maximum living area, sq ft. | |
| maxbeds | No | Maximum bedrooms. | |
| maxyear | No | Maximum year built. | |
| minarea | No | Minimum living area, sq ft. | |
| minbeds | No | Minimum bedrooms. | |
| minyear | No | Minimum year built. | |
| subtype | No | Property sub type; not every feed supports every value. | |
| counties | No | Counties (case-insensitive). | |
| features | No | Interior features, e.g. 'Wet Bar'. | |
| maxacres | No | Maximum acreage. | |
| maxbaths | No | Maximum bathrooms. | |
| maxprice | No | Maximum price. | |
| minacres | No | Minimum acreage. | |
| minbaths | No | Minimum bathrooms. | |
| minprice | No | Minimum price. | |
| modified | No | Only listings whose MLS modification time is on or after this date or date-time. | |
| ownership | No | Ownership values (feed dependent). | |
| salesAgent | No | Selling agent MLS ids (sales.agent). | |
| coListAgent | No | Co-listing agent MLS ids. | |
| maxlistdate | No | Listed on or before this date or date-time (UTC unless a timezone is given). | |
| minlistdate | No | Listed on or after this date or date-time (UTC unless a timezone is given). | |
| postalCodes | No | Postal / zip codes. | |
| subTypeText | No | Original MLS sub type text values. | |
| neighborhoods | No | Neighborhoods or subdivisions (case-insensitive). | |
| maxGarageSpaces | No | Maximum garage spaces. | |
| minGarageSpaces | No | Minimum garage spaces. | |
| exteriorFeatures | No | Exterior features, e.g. 'Porch'. | |
| specialListingConditions | No | Special conditions such as REO, Short Sale or Auction (feed dependent). |