Property Search and Filtering

POST /v2/PropertySearch

Search and filter properties with advanced criteria including geographic, demographic, and financial filters. Supports pagination and various output formats. Perfect for list building and property analytics.

Headers

x-api-key string Required

API key for authentication
x-user-id string

Optional user identifier for tracking and analytics

application/json

Body Required

Property Search Request Body

count boolean

Return only the count of matching properties
ids array[string | integer]

List of specific property IDs to retrieve
ids_only boolean

Return only property IDs, not full property data
obfuscate boolean

Obfuscate sensitive property information
summary boolean

Return summarized property data
resultIndex integer

Starting index for pagination

Minimum value is 0.
size integer

Number of results to return

Minimum value is 1, maximum value is 1000. Default value is 10.
limit integer

Maximum number of results

Minimum value is 0.
county string

County name to search within
state string

State abbreviation

Format should match the following pattern: ^[A-Z]{2}$.
city string

City name
address string

Full address string
latitude number

Latitude for radius search

Minimum value is -90, maximum value is 90.
longitude number

Longitude for radius search

Minimum value is -180, maximum value is 180.
radius number

Search radius in miles

Minimum value is 0.01, maximum value is 1000.
polygon array[array]

Polygon coordinates for geographic search
beds_min integer

Minimum number of bedrooms

Minimum value is 0, maximum value is 99.
beds_max integer

Maximum number of bedrooms

Minimum value is 0, maximum value is 99.
baths_min number

Minimum number of bathrooms

Minimum value is 0, maximum value is 99.
baths_max number

Maximum number of bathrooms

Minimum value is 0, maximum value is 99.
value_min number

Minimum property value

Minimum value is 0.
value_max number

Maximum property value

Minimum value is 0.
year_built_min integer

Minimum year built

Minimum value is 1800, maximum value is 2100.
year_built_max integer

Maximum year built

Minimum value is 1800, maximum value is 2100.
lot_size_min number

Minimum lot size in square feet

Minimum value is 0.
lot_size_max number

Maximum lot size in square feet

Minimum value is 0.
building_size_min number

Minimum building size in square feet

Minimum value is 0.
building_size_max number

Maximum building size in square feet

Minimum value is 0.
property_type array[string]

Property type filters

Values are SFR, MFR, CON, TH, MOB, APT, COM, IND, or VAC.
for_sale boolean

Filter for properties currently for sale
owner_occupied boolean

Filter for owner-occupied properties
absentee_owner boolean

Filter for absentee owner properties
corporate_owned boolean

Filter for corporate-owned properties
high_equity boolean

Filter for high equity properties
foreclosure boolean

Filter for properties in foreclosure
pre_foreclosure boolean

Filter for properties in pre-foreclosure
auction boolean

Filter for properties going to auction
cash_buyer boolean

Filter for cash buyer properties
investor_buyer boolean

Filter for investor buyer properties

Responses

200 application/json

Successful response with property search results
Hide response attributes Show response attributes object
- live boolean
  
  Indicates if the data is live from the API
- input object
  
  Response input parameters for a Property Search request
- data array[object]
  
  Array of property results
  
  Hide data attributes Show data attributes object
  
  absenteeOwner boolean
  
  Default value is true.
  
  address object
  
  Hide address attributes Show address attributes object
  
  address string
  
  city string
  
  county string
  
  state string
  
  street string
  
  zip string
  
  adjustableRate boolean
  
  Default value is true.
  
  airConditioningAvailable boolean
  
  Default value is true.
  
  assessedImprovementValue integer
  
  Default value is 0.
  
  assessedLandValue integer
  
  Default value is 0.
  
  assessedValue integer
  
  Default value is 0.
  
  auction boolean
  
  Default value is true.
  
  basement boolean
  
  Default value is true.
  
  bathrooms integer
  
  Default value is 0.
  
  bedrooms integer
  
  Default value is 0.
  
  cashBuyer boolean
  
  Default value is true.
  
  corporateOwned boolean
  
  Default value is true.
  
  death boolean
  
  Default value is true.
  
  distressed boolean
  
  Default value is true.
  
  documentType string
  
  documentTypeCode string
  
  equity boolean
  
  Default value is true.
  
  equityPercent integer
  
  Default value is 0.
  
  estimatedEquity integer
  
  Default value is 0.
  
  estimatedValue integer
  
  Default value is 0.
  
  floodZone boolean
  
  Default value is true.
  
  floodZoneDescription string
  
  floodZoneType string
  
  foreclosure boolean
  
  Default value is true.
  
  forSale boolean
  
  Default value is true.
  
  freeClear boolean
  
  Default value is true.
  
  garage boolean
  
  Default value is true.
  
  highEquity boolean
  
  Default value is true.
  
  id string
  
  inherited boolean
  
  Default value is true.
  
  inStateAbsenteeOwner boolean
  
  Default value is true.
  
  investorBuyer boolean
  
  Default value is true.
  
  landUse string
  
  lastSaleAmount string
  
  lastSaleDate string
  
  latitude number
  
  Default value is 0.
  
  lenderName string
  
  longitude number
  
  Default value is 0.
  
  lotSquareFeet integer
  
  Default value is 0.
  
  mailAddress object
  
  Hide mailAddress attributes Show mailAddress attributes object
  
  address string
  
  city string
  
  county string
  
  state string
  
  street string
  
  zip string
  
  medianIncome string
  
  MFH2to4 boolean
  
  Default value is true.
  
  MFH5plus boolean
  
  Default value is true.
  
  mlsActive boolean
  
  Default value is true.
  
  mlsCancelled boolean
  
  Default value is true.
  
  mlsDaysOnMarket integer
  
  Default value is 0.
  
  mlsFailed boolean
  
  Default value is true.
  
  mlsHasPhotos boolean
  
  Default value is true.
  
  mlsLastSaleDate string
  
  mlsLastStatusDate string
  
  mlsListingDate string
  
  mlsListingPrice integer
  
  Default value is 0.
  
  mlsPending boolean
  
  Default value is true.
  
  mlsSold boolean
  
  Default value is true.
  
  mlsStatus string
  
  mlsType string
  
  negativeEquity boolean
  
  Default value is true.
  
  neighborhood object
  
  Hide neighborhood attributes Show neighborhood attributes object
  
  center string
  
  id string
  
  name string
  
  type string
  
  openMortgageBalance integer
  
  Default value is 0.
  
  outOfStateAbsenteeOwner boolean
  
  Default value is true.
  
  owner1FirstName string
  
  owner1LastName string
  
  owner2FirstName string
  
  owner2LastName string
  
  ownerOccupied boolean
  
  Default value is true.
  
  preForeclosure boolean
  
  Default value is true.
  
  privateLender boolean
  
  Default value is true.
  
  propertyId string
  
  propertyType string
  
  propertyUse string
  
  propertyUseCode integer
  
  Default value is 0.
  
  reo boolean
  
  Default value is true.
  
  roomsCount integer
  
  Default value is 0.
  
  squareFeet integer
  
  Default value is 0.
  
  suggestedRent string
  
  unitsCount integer
  
  Default value is 0.
  
  vacant boolean
  
  Default value is true.
  
  yearBuilt integer
  
  Default value is 0.
  
  yearsOwned integer
  
  Default value is 0.
- resultCount integer
  
  Total number of results found
- resultIndex integer
  
  Index of the last record returned in the current response data
- recordCount integer
  
  Number of records returned in the current response data
- statusCode integer
  
  HTTP status code of the response
- statusMessage string
  
  Status message corresponding to the status code
- requestExecutionTimeMS string
  
  Time taken to execute the request in milliseconds
400 application/json

Bad Request Response
Hide response attributes Show response attributes object
- statusCode integer
- error string
- message string
- validation object
  
  Hide validation attributes Show validation attributes object
  
  source string
  
  keys array[string]
401 application/json

Unauthorized Response
Hide response attributes Show response attributes object
- statusCode integer
- error string
- message string
404 application/json

Not Found Response
Hide response attributes Show response attributes object
- live boolean
- input object
  
  The input query parameters sent in the request.
- data array[object]
  
  Array of property records matching the query. Empty if no records found.
- count integer
  
  Total number of property records matching the query.
- statusCode integer Required
- statusMessage string Required
- requestExecutionTimeMS string
  
  Time taken to execute the request.

POST /v2/PropertySearch

curl \
 --request POST 'https://api.realestateapi.com/v2/PropertySearch' \
 --header "Content-Type: application/json" \
 --header "x-api-key: string" \
 --header "x-user-id: string" \
 --data '{"size":10,"state":"GA","county":"Forsyth","lot_size_max":8712000,"lot_size_min":435600,"property_type":"LAND"}'

Request examples

Basic Property Search Request

{
  "size": 10,
  "state": "GA",
  "county": "Forsyth",
  "lot_size_max": 8712000,
  "lot_size_min": 435600,
  "property_type": "LAND"
}

Count Property Search Request

{
  "count": true,
  "state": "GA"
}

IDs Only Property Search Request

{
  "size": 10,
  "state": "GA",
  "county": "Fulton",
  "ids_only": true,
  "property_type": "LAND"
}

Radius Property Search Request

{
  "size": 10,
  "radius": 3,
  "latitude": 33.7878,
  "longitude": -84.4455
}

Summary Property Search Request

{
  "size": 10,
  "state": "GA",
  "county": "Forsyth",
  "summary": true,
  "lot_size_max": 8712000,
  "lot_size_min": 435600,
  "property_type": "LAND"
}

Obfuscated Property Search Request

{
  "size": 10,
  "state": "GA",
  "county": "Forsyth",
  "obfuscate": true,
  "lot_size_max": 8712000,
  "lot_size_min": 435600,
  "property_type": "LAND"
}

Compound Property Search Request

{
  "or": [
    {
      "fips": "13057"
    },
    {
      "fips": "13063"
    },
    {
      "fips": "13067"
    },
    {
      "fips": "13077"
    },
    {
      "fips": "13085"
    },
    {
      "fips": "13089"
    },
    {
      "fips": "13097"
    },
    {
      "fips": "13113"
    },
    {
      "fips": "13117"
    },
    {
      "fips": "13121"
    },
    {
      "fips": "13135"
    },
    {
      "fips": "13151"
    },
    {
      "fips": "13217"
    },
    {
      "fips": "13223"
    },
    {
      "fips": "13247"
    },
    {
      "fips": "13297"
    }
  ],
  "size": 3,
  "state": "GA",
  "lot_size_max": 1000000,
  "lot_size_min": 435600,
  "property_type": "LAND"
}

Polygon Property Search Request

{
  "size": 3,
  "multi_polygon": [
    [
      {
        "lat": 33.511,
        "lon": -84.8367
      },
      {
        "lat": 33.5113,
        "lon": -84.6213
      },
      {
        "lat": 33.5026,
        "lon": -84.6094
      },
      {
        "lat": 33.5181,
        "lon": -84.5957
      },
      {
        "lat": 33.5509,
        "lon": -84.4587
      },
      {
        "lat": 33.644,
        "lon": -84.453
      },
      {
        "lat": 33.6479,
        "lon": -84.3499
      },
      {
        "lat": 33.9681,
        "lon": -84.3474
      },
      {
        "lat": 33.9666,
        "lon": -84.3179
      },
      {
        "lat": 33.9576,
        "lon": -84.2771
      },
      {
        "lat": 33.9682,
        "lon": -84.2581
      },
      {
        "lat": 33.9874,
        "lon": -84.2623
      },
      {
        "lat": 33.9861,
        "lon": -84.2547
      },
      {
        "lat": 33.9983,
        "lon": -84.2483
      },
      {
        "lat": 34.0038,
        "lon": -84.2125
      },
      {
        "lat": 33.9971,
        "lon": -84.2021
      },
      {
        "lat": 33.9901,
        "lon": -84.2048
      },
      {
        "lat": 33.9987,
        "lon": -84.1809
      },
      {
        "lat": 34.0287,
        "lon": -84.1681
      },
      {
        "lat": 34.0343,
        "lon": -84.1212
      },
      {
        "lat": 34.0507,
        "lon": -84.0977
      },
      {
        "lat": 34.0599,
        "lon": -84.1536
      },
      {
        "lat": 34.0704,
        "lon": -84.1783
      },
      {
        "lat": 34.0855,
        "lon": -84.1894
      },
      {
        "lat": 34.0991,
        "lon": -84.2138
      },
      {
        "lat": 34.1027,
        "lon": -84.2446
      },
      {
        "lat": 34.1096,
        "lon": -84.259
      },
      {
        "lat": 34.1859,
        "lon": -84.259
      },
      {
        "lat": 34.1862,
        "lon": -84.3286
      },
      {
        "lat": 34.1743,
        "lon": -84.3562
      },
      {
        "lat": 34.1242,
        "lon": -84.3621
      },
      {
        "lat": 34.109,
        "lon": -84.4184
      },
      {
        "lat": 34.0552,
        "lon": -84.4191
      },
      {
        "lat": 34.0259,
        "lon": -84.4012
      },
      {
        "lat": 34.0027,
        "lon": -84.3942
      },
      {
        "lat": 33.9873,
        "lon": -84.375
      },
      {
        "lat": 33.9667,
        "lon": -84.3838
      },
      {
        "lat": 33.9251,
        "lon": -84.4301
      },
      {
        "lat": 33.9121,
        "lon": -84.4466
      },
      {
        "lat": 33.8785,
        "lon": -84.4438
      },
      {
        "lat": 33.8421,
        "lon": -84.4605
      },
      {
        "lat": 33.8268,
        "lon": -84.4555
      },
      {
        "lat": 33.8273,
        "lon": -84.4689
      },
      {
        "lat": 33.699,
        "lon": -84.6329
      },
      {
        "lat": 33.6931,
        "lon": -84.6303
      },
      {
        "lat": 33.6836,
        "lon": -84.6527
      },
      {
        "lat": 33.6578,
        "lon": -84.659
      },
      {
        "lat": 33.6369,
        "lon": -84.7297
      },
      {
        "lat": 33.6246,
        "lon": -84.7358
      },
      {
        "lat": 33.6321,
        "lon": -84.7504
      },
      {
        "lat": 33.6152,
        "lon": -84.7623
      },
      {
        "lat": 33.5861,
        "lon": -84.8061
      },
      {
        "lat": 33.5457,
        "lon": -84.8331
      },
      {
        "lat": 33.5192,
        "lon": -84.8174
      },
      {
        "lat": 33.511,
        "lon": -84.8367
      }
    ]
  ]
}

Response examples (200)

{
  "live": true,
  "input": {},
  "data": [
    {
      "absenteeOwner": false,
      "address": {
        "address": "13723 Neil Armstrong Ave Unit 308, Herndon, Va 20171",
        "city": "Herndon",
        "county": "Fairfax",
        "state": "VA",
        "street": "13723 Neil Armstrong Ave Unit 308",
        "zip": "20171"
      },
      "adjustableRate": false,
      "airConditioningAvailable": false,
      "assessedImprovementValue": 326590,
      "assessedLandValue": 82000,
      "assessedValue": 408590,
      "auction": false,
      "basement": false,
      "bathrooms": 2,
      "bedrooms": 2,
      "cashBuyer": false,
      "corporateOwned": false,
      "death": false,
      "distressed": false,
      "documentType": "Grant Deed",
      "documentTypeCode": "DTGD",
      "equity": false,
      "equityPercent": 38,
      "estimatedEquity": 189084,
      "estimatedValue": 490308,
      "floodZone": true,
      "floodZoneDescription": "AREA OF MINIMAL FLOOD HAZARD",
      "floodZoneType": "X",
      "foreclosure": false,
      "forSale": false,
      "freeClear": false,
      "garage": false,
      "highEquity": false,
      "id": "253175355",
      "inherited": false,
      "inStateAbsenteeOwner": false,
      "investorBuyer": false,
      "landUse": "Residential",
      "lastSaleAmount": "418000",
      "lastSaleDate": "2020-07-23",
      "latitude": 38.9207,
      "lenderName": "One American Mtg",
      "longitude": -77.4218,
      "lotSquareFeet": 0,
      "mailAddress": {
        "address": "13723 Neil Armstrong Ave Unit 308, Herndon, Va 20171",
        "city": "Herndon",
        "county": "Fairfax",
        "state": "VA",
        "street": "13723 Neil Armstrong Ave Unit 308",
        "zip": "20171"
      },
      "medianIncome": "150066",
      "MFH2to4": false,
      "MFH5plus": false,
      "mlsActive": true,
      "mlsCancelled": false,
      "mlsDaysOnMarket": 101,
      "mlsFailed": false,
      "mlsHasPhotos": false,
      "mlsLastSaleDate": "2020-07-23",
      "mlsLastStatusDate": "2023-04-15",
      "mlsListingDate": "2023-04-15",
      "mlsListingPrice": 2500,
      "mlsPending": false,
      "mlsSold": false,
      "mlsStatus": "Active",
      "mlsType": "ForSale",
      "negativeEquity": false,
      "neighborhood": {
        "center": "POINT(-77.421701188095 38.919564722822)",
        "id": "63205",
        "name": "Discovery Square",
        "type": "subdivision"
      },
      "openMortgageBalance": 313500,
      "outOfStateAbsenteeOwner": false,
      "owner1FirstName": "Attili",
      "owner1LastName": "Srinivas",
      "owner2FirstName": "Attili",
      "owner2LastName": "Manjusha",
      "ownerOccupied": true,
      "preForeclosure": false,
      "privateLender": false,
      "propertyId": "253175355",
      "propertyType": "CONDO",
      "propertyUse": "Condominium",
      "propertyUseCode": 366,
      "reo": false,
      "roomsCount": 5,
      "squareFeet": 1323,
      "suggestedRent": "2070",
      "unitsCount": 0,
      "vacant": false,
      "yearBuilt": 2015,
      "yearsOwned": 3
    }
  ],
  "resultCount": 150,
  "resultIndex": 250,
  "recordCount": 50,
  "statusCode": 200,
  "statusMessage": "OK",
  "requestExecutionTimeMS": "150ms"
}

Response examples (400)

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "\"x-api-key\" is required",
  "validation": {
    "source": "headers",
    "keys": [
      "x-api-key"
    ]
  }
}

Response examples (401)

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Your test key has expired. Please contact support to continue testing."
}

Response examples (404)

{
  "live": false,
  "input": {},
  "data": [
    {}
  ],
  "count": 0,
  "statusCode": 404,
  "statusMessage": "Not Found",
  "requestExecutionTimeMS": "18ms"
}