Raw schema
{
"type": "object",
"properties": {
"q": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Keyword search over MLS number, street, unit, city, postal code, subdivision and area; several values match any."
},
"status": {
"description": "Listing status (default Active). Closed = sold or leased.",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"enum": [
"Active",
"Pending",
"Closed",
"ActiveUnderContract",
"Hold",
"Withdrawn",
"Expired",
"Delete",
"Incomplete",
"ComingSoon"
]
}
},
"type": {
"description": "Property type (default residential and rental).",
"minItems": 1,
"maxItems": 9,
"type": "array",
"items": {
"type": "string",
"enum": [
"residential",
"rental",
"mobilehome",
"condominium",
"multifamily",
"commercial",
"commerciallease",
"land",
"farm"
]
}
},
"subtype": {
"description": "Property sub type; not every feed supports every value.",
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"enum": [
"apartment",
"boatslip",
"singlefamilyresidence",
"deededparking",
"cabin",
"condominium",
"duplex",
"manufacturedhome",
"ownyourown",
"quadruplex",
"stockcooperative",
"townhouse",
"timeshare",
"triplex",
"manufacturedonland",
"farmandranch",
"agriculture",
"business",
"hotelmotel",
"industrial",
"mixeduse",
"officespace",
"retail",
"unimprovedland",
"warehouse"
]
}
},
"agent": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Listing agent MLS ids (the co-listing agent is not matched)."
},
"salesAgent": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Selling agent MLS ids (sales.agent)."
},
"brokers": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Broker or listing office ids, as your MLS provides them."
},
"minprice": {
"description": "Minimum price.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"maxprice": {
"description": "Maximum price.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"minarea": {
"description": "Minimum living area, sq ft.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"maxarea": {
"description": "Maximum living area, sq ft.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"minbaths": {
"description": "Minimum bathrooms.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"maxbaths": {
"description": "Maximum bathrooms.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"minbeds": {
"description": "Minimum bedrooms.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"maxbeds": {
"description": "Maximum bedrooms.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"maxdom": {
"description": "Maximum days on market (needs Days on Market data in the feed).",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"minyear": {
"description": "Minimum year built.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"maxyear": {
"description": "Maximum year built.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"minacres": {
"description": "Minimum acreage.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"maxacres": {
"description": "Maximum acreage.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"minGarageSpaces": {
"description": "Minimum garage spaces.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"maxGarageSpaces": {
"description": "Maximum garage spaces.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"postalCodes": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Postal / zip codes."
},
"cities": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Cities (case-insensitive). simplyrets_get_feed_metadata lists the cities in the feed."
},
"counties": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Counties (case-insensitive)."
},
"neighborhoods": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Neighborhoods or subdivisions (case-insensitive)."
},
"features": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Interior features, e.g. 'Wet Bar'."
},
"exteriorFeatures": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Exterior features, e.g. 'Porch'."
},
"pool": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Pool: 'true', 'false' or a value such as 'Private'."
},
"water": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Water body: 'true', 'false' or a value."
},
"points": {
"description": "A polygon of 'lat,lng' points (3 or more); returns listings inside it. Needs latitude/longitude in the feed.",
"minItems": 3,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"pattern": "^-?\\d{1,3}(\\.\\d+)?\\s*,\\s*-?\\d{1,3}(\\.\\d+)?$"
}
},
"idx": {
"description": "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.",
"type": "string",
"enum": [
"null",
"listing",
"address",
"ignore"
]
},
"vendor": {
"description": "MLS vendor id; required on multi-MLS apps (simplyrets_get_account_info lists them).",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"subTypeText": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Original MLS sub type text values."
},
"coListAgent": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Co-listing agent MLS ids."
},
"specialListingConditions": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Special conditions such as REO, Short Sale or Auction (feed dependent)."
},
"ownership": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Ownership values (feed dependent)."
},
"state": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "State or province (case-insensitive)."
},
"minlistdate": {
"description": "Listed on or after this date or date-time (UTC unless a timezone is given).",
"type": "string",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}|\\d{1,2}\\/\\d{1,2}\\/\\d{4})([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?( ?(Z|[+-]\\d{2}:?\\d{2}|[A-Za-z]{2,5}))?)?$"
},
"maxlistdate": {
"description": "Listed on or before this date or date-time (UTC unless a timezone is given).",
"type": "string",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}|\\d{1,2}\\/\\d{1,2}\\/\\d{4})([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?( ?(Z|[+-]\\d{2}:?\\d{2}|[A-Za-z]{2,5}))?)?$"
},
"modified": {
"description": "Only listings whose MLS modification time is on or after this date or date-time.",
"type": "string",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}|\\d{1,2}\\/\\d{1,2}\\/\\d{4})([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?( ?(Z|[+-]\\d{2}:?\\d{2}|[A-Za-z]{2,5}))?)?$"
},
"include": {
"description": "Extra fields: compliance (IDX display data) and rooms (when the feed has them).",
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"compliance",
"rooms"
]
}
},
"sort": {
"description": "Sort field; a leading minus is descending. Ignored with lastId.",
"type": "string",
"enum": [
"listprice",
"-listprice",
"listdate",
"-listdate",
"closedate",
"-closedate",
"beds",
"-beds",
"baths",
"-baths"
]
},
"count": {
"description": "Also return the total number of matches (slower on big feeds).",
"type": "boolean"
},
"limit": {
"description": "Results per page, 1-100 (default 10).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"description": "Records to skip (the previous reply's next.offset). Do not combine with lastId.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"lastId": {
"description": "Cursor: 0 for the first page, then the previous reply's next.lastId (sort is ignored when set).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}