GET
/
public
/
property
/
search
/
Property Search
curl --request GET \
  --url https://app.realie.ai/api/public/property/search/ \
  --header 'Authorization: <api-key>'
{
  "properties": [
    {}
  ],
  "metadata": {
    "limit": 123,
    "offset": 123,
    "count": 123
  }
}

Authorizations

​
Authorization
string
header
required

Provide your API key directly in the header.

Query Parameters

​
state
string

The state (e.g. “CA”) where the property is located. Required when using county, city, or zipCode parameters.

​
zipCode
string

The ZIP code of the property. Requires state parameter.

​
county
string

The county where the property is located. Requires state parameter.

​
city
string

The city where the property is located. Requires state parameter.

​
transferedSince
string

Number of days to look back for property transfers. Returns properties that were transferred within the specified number of days.

​
useCode
integer

The numerical code that identifies the use of a property (e.g., residential, commercial, etc.). Requires state parameter.

​
address
string

The street address only (e.g. “123 Main Street”). Do not include city, state, or ZIP.

​
unitNumberStripped
string

The unit number of the property (optional). Do not inclue the type of unit. (e.g. “APT 2B” would just be “2B”)

​
limit
integer
default:10

Maximum number of results to return. Defaults to 10, maximum is 100.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of records to skip. Defaults to 0.

Required range: x >= 0
​
residential
boolean

Filter for residential properties only. If true, returns only residential properties. If false, returns only non-residential properties.

Response

200
application/json

Properties found successfully

The response is of type object.