The SimplyRETS Listings API

v1.0.0

This is the main endpoint for accessing your properties. View all of the available query parameters and make requests below! The API uses Basic Authentication, which most HTTP libraries will handle for you. To use the test data (which is what this pages uses), you can use the api key simplyrets and secret simplyrets. Note that these test listings are not live MLS listings but the data, query parameters, and response bodies will all work the same.

Input

{
  "type": "object",
  "properties": {
    "agent": {
      "type": "string"
    },
    "brokers": {
      "type": "string"
    },
    "cities": {
      "type": "string"
    },
    "count": {
      "type": "string"
    },
    "counties": {
      "type": "string"
    },
    "features": {
      "type": "string"
    },
    "include": {
      "type": "string"
    },
    "lastId": {
      "type": "string"
    },
    "limit": {
      "type": "string"
    },
    "maxarea": {
      "type": "string"
    },
    "maxbaths": {
      "type": "string"
    },
    "maxbeds": {
      "type": "string"
    },
    "maxdom": {
      "type": "string"
    },
    "maxprice": {
      "type": "string"
    },
    "minarea": {
      "type": "string"
    },
    "minbaths": {
      "type": "string"
    },
    "minbeds": {
      "type": "string"
    },
    "minprice": {
      "type": "string"
    },
    "minyear": {
      "type": "string"
    },
    "neighborhoods": {
      "type": "string"
    },
    "offset": {
      "type": "string"
    },
    "points": {
      "type": "string"
    },
    "postalCodes": {
      "type": "string"
    },
    "q": {
      "type": "string"
    },
    "sort": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "subtype": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "vendor": {
      "type": "string"
    },
    "water": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}