✈️

properties

Real estate property listing with type, location, pricing, specifications (bedrooms, bathrooms, area), year built, features, and images. Used for property rental platforms, real estate marketplaces, and accommodation booking systems.

🎯 Request Builder

https://api.mockly.codes/properties?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/properties

Get a collection of properties

Alternative: /travel/properties
GET/properties/:id

Get a single property by ID

Alternative: /travel/properties/:id
GET/properties/meta

Get resource metadata and schema

Alternative: /travel/properties/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/properties?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/properties?q=laptop&search_fields=name,description

💡 Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 properties
fetch('https://api.mockly.codes/properties?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/properties?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/properties?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/properties?nocache=true')

Schema Properties

idinteger

Unique identifier for the property

Gen:random_int
titlestring

Property title or listing name

Gen:property_title
descriptionstring

Detailed description of the property, amenities, and features

Gen:paragraph
typestring

Property type (e.g., Apartment, House, Villa, Condo, Studio)

Gen:property_type
statusstring

Property status (e.g., available, rented, sold, under_maintenance)

Gen:property_status
addressstring

Street address of the property

Gen:address
citystring

City where the property is located

Gen:city
statestring

State or province where the property is located

Gen:state
countrystring

Country where the property is located

Gen:country
zip_codestring

Postal or ZIP code

Gen:zip
latitudenumber

Geographic latitude coordinate of the property

Gen:latitude
longitudenumber

Geographic longitude coordinate of the property

Gen:longitude
pricenumber

Property price (sale) or rental rate per period

Gen:property_price
currencystring

ISO currency code for the price (e.g., USD, EUR, GBP)

Gen:currency
bedroomsinteger

Number of bedrooms

Gen:bedrooms
bathroomsinteger

Number of bathrooms

Gen:bathrooms
areanumber

Total area in square meters

Gen:property_area
year_builtinteger

Year when the property was built

Gen:year_built
featuresarray

Array of property features (e.g., WiFi, Parking, Pool, Garden, Air Conditioning)

Gen:property_features
imagestring

URL to the property's main image

Gen:image_urluri

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request