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

Authorizations

Authorization
string
header
required

Provide your API key directly in the header.

Query Parameters

longitude
number
required

The longitude coordinate of the center point for the search.

latitude
number
required

The latitude coordinate of the center point for the search.

radius
number
default:
1

The radius in miles to search from the center point. Maximum value is 2 miles.

Required range: 0 <= x <= 2
limit
integer
default:
10

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

Required range: 1 <= x <= 500
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
properties
object[]

Array of properties found within the specified radius.

metadata
object