Skip to main content

Filter

POST /v1/properties/filter

Returns properties that match the query as GeoJSON.

Query Parameters

count
integer
Required

How many properties should be returned.

longitude
float
Required

The longitude of the center of the search.

latitude
float
Required

The latitude of the center of the search.

filters[property_type]
string
Optional
Defaults to all

The type of the property can be all, single_family or multi_family.

filters[bathrooms][from]
float
Optional

The minimum amount of bathrooms.

filters[bathrooms][to]
float
Optional

The maximum amount of bathrooms.

filters[bedrooms][from]
float
Optional

The minimum amount of bedrooms.

filters[bedrooms][to]
float
Optional

The maximum amount of bedrooms.

filters[lot_size][from]
float
Optional

The minimum value of lot size in square feet.

filters[lot_size][to]
float
Optional

The maximum value of lot size in square feet.

filters[square_feet][from]
float
Optional

The minimum value of living area in square feet.

filters[square_feet][to]
float
Optional

The maximum value of living area in square feet.

filters[year_build][from]
float
Optional

The minimum value for year built of the dwelling.

filters[year_build][to]
float
Optional

The maximum value for year built of the dwelling.

filters[sold_for][from]
float
Optional

The minimum value for last known sale in dollars.

filters[sold_for][to]
float
Optional

The maximum value for last known sale in dollars.

filters[sold_at][from]
float
Optional

The minimum value for the year of last known sale of the property.

filters[sold_at][to]
float
Optional

The maximum value for the year of last known sale of the property.

polygon
array
Optional

The geo-polygons to use when filtering.

skipped_property_ids
array
Optional

The property ids to remove from the mailing list.

Example Request
curl -X POST https://api.realmailers.com/v1/properties/filter \
  -d "count"="20" \
  -d "longitude"="-74.0059728" \
  -d "latitude"="40.7127753"
Response Schema
Array({
  type: String
  features: Array({
    type: String

    geometry: {
      coordinates: Array(Number)
    }

    properties: {
      ids: Array(Number)
      removed: Boolean
      units: Number
      data: String
    }
  })
})