All Real Estate Paginated Details

Request

Query Params

page

integer <int32> | null

optional

per_page

integer <int32> | null

optional

sort

string | null

optional

filter

string | null

optional

Header Params

Authorization

string

optional

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://docs.joinclutch.xyz/api/real_estate/property_details?page&per_page&sort&filter' \
--header 'Authorization;'

Responses

🟢200Get all real estate paginated details

application/json

Body

pagination

object (ApiPagination)

required

current_page

integer <int32>

required

per_page

integer <int32>

required

total_pages

integer <int32>

required

total_records

integer <int32>

required

results

array[object (ApiPropertyDetail) {16}]

required

address

string | null

optional

country

string | null

optional

gross_rent_month

string | null

optional

gross_rent_month_num

number <double> | null

optional

gross_rent_year

string | null

optional

gross_rent_year_num

number <double> | null

optional

letting_status

string | null

optional

listing_date

string | null

optional

market_value

string | null

optional

market_value_num

number <double> | null

optional

number_of_units

string | null

optional

number_of_units_num

number <double> | null

optional

postcode

string | null

optional

property_id

string

required

property_type

string | null

optional

protocol

string | null

optional

Example

{
    "pagination": {
        "current_page": 1,
        "per_page": 10,
        "total_pages": 5,
        "total_records": 50
    },
    "results": [
        {
            "address": "123 Main St, New York, NY 10001",
            "country": "United States",
            "gross_rent_month": "$25,000",
            "gross_rent_month_num": 25000,
            "gross_rent_year": "$300,000",
            "gross_rent_year_num": 300000,
            "letting_status": "Occupied",
            "listing_date": "2023-08-01",
            "market_value": "$5,000,000",
            "market_value_num": 5000000,
            "number_of_units": "50",
            "number_of_units_num": 50,
            "postcode": "10001",
            "property_id": "PROP-001",
            "property_type": "Multi-family",
            "protocol": "RealT"
        },
        {
            "address": "456 Oak Ave, Los Angeles, CA 90001",
            "country": "United States",
            "gross_rent_month": "$18,000",
            "gross_rent_month_num": 18000,
            "gross_rent_year": "$216,000",
            "gross_rent_year_num": 216000,
            "letting_status": "Vacant",
            "listing_date": "2023-07-15",
            "market_value": "$3,500,000",
            "market_value_num": 3500000,
            "number_of_units": "30",
            "number_of_units_num": 30,
            "postcode": "90001",
            "property_id": "PROP-002",
            "property_type": "Apartment Complex",
            "protocol": "Lofty AI"
        }
    ]
}

🔴500Error