Step 1: Set your Geo(s)


MLS Board Codes

  • mls_board_code [string] or [array of strings]

Single MLS Board Code:

{
  "city": "Richmond",
  "state": "VA",
  "active": true,
  "mls_board_code": "mdbmls-r"
}

Multiple MLS Board Codes:

{
  "city": "Richmond",
  "state": "VA",
  "active": true,
  "mls_board_code": ["mdbmls-r", "ohneoh", "scctmls"]
}

Zip

  • zip [string] or [array of strings]
{
  "zip": "22205",
  "active": true
}
{
  "active": true,
  "zip": ["22205", "20301"]
}

City, County

  • city [string]
  • county [string]

City Example:

{
  "city": "Arlington",
  "state": "VA",
  "active": true
}

County Example:

{
  "county": "Henrico",
  "state": "VA",
  "active": true
}

Multiple Cities / Counties using Compound Queries:

{
  "active": true,
  "and": [
    {
      "or": [
        { "city": "Richmond", "state": "VA" },
        { "city": "Farmville", "state": "VA" },
        { "city": "Arlington", "state": "VA" },
        { "county": "Henrico", "state": "VA" }
      ]
    }
  ]
}

Search Radius

  • radius works with latitude/longitude, address, id and listing_id

Around an address:

{
  "address": "6806 19th Rd N, Arlington, VA 22205",
  "active": true,
  "radius": 2
}

Around a latitude/longitude coordinate pair:

{
  "latitude": "38.885980589900285",
  "longitude": "-77.15999383193586",
  "active": true,
  "radius": 2
}

Polygon / Multiple Polygons

Single Polygon:

{
  "active": true,
  "polygon": [
    { "lat": "35.42300740560803", "lon": "-86.32762085355883" },
    { "lat": "35.19184584103132", "lon": "-86.43359069901402" },
    { "lat": "35.15490990082178", "lon": "-86.0572016901352" }
  ]
}

Multiple Polygons:

{
  "active": true,
  "multi_polygon": [
    [
      { "lat": "35.42300740560803", "lon": "-86.32762085355883" },
      { "lat": "35.19184584103132", "lon": "-86.43359069901402" },
      { "lat": "35.15490990082178", "lon": "-86.0572016901352" }
    ],
    [
      { "lat": "36.42300740560803", "lon": "-87.32762085355883" },
      { "lat": "36.19184584103132", "lon": "-87.43359069901402" },
      { "lat": "36.15490990082178", "lon": "-87.0572016901352" }
    ]
  ]
}