Properties API Reference

List Properties

GET /api/v1/properties

Retrieve a list of properties based on various filter criteria.

Query Parameters

Parameter	Type	Description
page	Number	Page number (default: 1)
limit	Number	Number of items per page (default: 20, max: 100)
bedrooms	Number	Number of bedrooms
bathrooms	Number	Number of bathrooms
carspaces	Number	Number of car spaces
address	String	Full or partial address (case-insensitive, partial match)
street	String	Street name (case-insensitive, partial match)
suburb	String	Suburb name(s), can be comma-separated for multiple suburbs (case-insensitive, exact match)
fullSuburb	String	Full suburb details, can be comma-separated (case-insensitive, exact match)
state	String	State name (case-insensitive, exact match)
postcode	String	Postcode (case-insensitive, exact match)
listingType	String	Type of listing. Can be comma-separated for multiple types.

Example Request

javascript

const headers = {
  "x-access-key": "your_access_key_here",
  "x-secret-key": "your_secret_key_here",
};

fetch("https://agencyhubapi.stepps.net/api/v1/properties?bedrooms=3&suburb=ALDERLEY,NEWMARKET&state=QLD", { headers })
  .then((response) => response.json())
  .then((data) => console.log(data));

Example Response

json

{
  "total": 319402,
  "hasNext": true,
  "totalPage": 15971,
  "data": [
    {
      "address": {
        "display": true,
        "fullAddress": "38/79-91 Macpherson Street WARRIEWOOD NSW 2102",
        "streetAddress": "38/79-91 Macpherson Street",
        "fullSuburb": "WARRIEWOOD NSW 2102",
        "streetview": true,
        "subNumber": "38",
        "lotNumber": "",
        "streetNumber": "79-91",
        "street": "Macpherson Street",
        "suburb": "WARRIEWOOD",
        "state": "NSW",
        "postcode": "2102",
        "country": "AUS",
        "latitude": "-33.6894594",
        "longitude": "151.2953097"
      },
      "createdAt": "2024-09-11T04:02:36.011Z",
      "features": {
        "bedrooms": 1,
        "bathrooms": 1,
        "parkingSpaces": 1
      },
      "id": 420043,
      "updatedAt": "2024-09-11T04:02:36.011Z",
      "listings": {
        "_id": "66e1165ceffa544215c73ef5",
        "agentID": "25428",
        "uniqueID": "l30492221",
        "websiteID": 2,
        "category": "house",
        "images": [
          {
            "id": "m",
            "url": "https://propertyimages.stepps.net/2-lsre/o/25428-residential-L30492221-1726027353qAAzzE.jpg",
            "type": "featured"
          },
          {
            "id": "a",
            "url": "https://propertyimages.stepps.net/2-lsre/o/25428-residential-L30492221-1726027353B7DrGs.jpg",
            "type": "img"
          }
        ]
        // ... other listing details
      }
      // ... other property details
    }
    // ... more properties
  ]
}

Get a Single Property

GET /api/v1/properties/{id}

Retrieve details of a specific property by its ID.

Path Parameters

Parameter	Type	Description
id	String	Unique identifier of the property

Example Request

javascript

const headers = {
  "x-access-key": "your_access_key_here",
  "x-secret-key": "your_secret_key_here",
};

fetch("https://agencyhubapi.stepps.net/api/v1/properties/123", { headers })
  .then((response) => response.json())
  .then((data) => console.log(data));

Example Response

json

{
  "address": {
    "display": true,
    "fullAddress": "38/79-91 Macpherson Street WARRIEWOOD NSW 2102",
    "streetAddress": "38/79-91 Macpherson Street",
    "fullSuburb": "WARRIEWOOD NSW 2102",
    "streetview": true,
    "subNumber": "38",
    "lotNumber": "",
    "streetNumber": "79-91",
    "street": "Macpherson Street",
    "suburb": "WARRIEWOOD",
    "state": "NSW",
    "postcode": "2102",
    "country": "AUS",
    "latitude": "-33.6894594",
    "longitude": "151.2953097"
  },
  "createdAt": "2024-09-11T04:02:36.011Z",
  "features": {
    "bedrooms": 1,
    "bathrooms": 1,
    "parkingSpaces": 1
  },
  "id": 420043,
  "updatedAt": "2024-09-11T04:02:36.011Z",
  "listings": [
    {
      "agentID": "25428",
      "uniqueID": "l30492221",
      "address": {
        "display": true,
        "fullAddress": "38/79-91 Macpherson Street WARRIEWOOD NSW 2102",
        "streetAddress": "38/79-91 Macpherson Street",
        "fullSuburb": "WARRIEWOOD NSW 2102",
        "streetview": true,
        "subNumber": "38",
        "lotNumber": "",
        "streetNumber": "79-91",
        "street": "Macpherson Street",
        "suburb": "WARRIEWOOD",
        "state": "NSW",
        "postcode": "2102",
        "country": "AUS",
        "latitude": "-33.6894594",
        "longitude": "151.2953097"
      },
      "agents": [
        {
          "id": 101771,
          "name": "John Doe",
          "telephone": [
            {
              "number": "0414 000 000",
              "type": "mobile"
            }
          ],
          "email": "aget-name@realestatewebsite.com.au",
          "profileVisibility": true,
          "profileImage": "https://realestatewebsite.com.au/agent-name.jpg",
          "profileLink": "https://realestatewebsite.com.au/agent-name/",
          "hasCurrentListings": true
        }
      ],
      "auctionDetails": {},
      "authority": "exclusive",
      "buildingDetails": {
        "area": {
          "value": 0,
          "unit": "squareMeter"
        },
        "energyRating": ""
      },
      "businessCategory": [],
      "category": "house",
      "commercialAuthority": "",
      "commercialCategory": [],
      "commercialListingType": "",
      "commercialRent": {
        "value": 0,
        "period": "",
        "tax": ""
      },
      "createdAt": "2024-09-11T04:02:36.107Z",
      "description": "",
      "diakritLinks": {
        "furnish": [],
        "kitchenStyling": [],
        "panorama": []
      },
      "documents": [],
      "ecoFriendly": {
        "greyWaterSystem": false,
        "waterTank": false,
        "solarPanels": false,
        "solarHotWater": false
      },
      "exclusivity": "",
      "externalLinks": [],
      "features": {
        "bedrooms": 1,
        "bathrooms": 1,
        "garages": 1,
        "carports": 0,
        "openSpaces": 0,
        "ensuite": 0,
        "toilets": 0,
        "otherFeatures": "",
        "airConditioning": false,
        "alarmSystem": false,
        "balcony": false,
        "broadband": false,
        "builtInRobes": false,
        "courtyard": false,
        "deck": false,
        "dishwasher": false,
        "ductedCooling": false,
        "ductedHeating": false,
        "evaporativeCooling": false,
        "gasHeating": false,
        "gym": false,
        "hydronicHeating": false,
        "insideSpa": false,
        "intercom": false,
        "openFirePlace": false,
        "outdoorEnt": false,
        "outsideSpa": false,
        "payTV": false,
        "poolInGround": false,
        "poolAboveGround": false,
        "remoteGarage": false,
        "reverseCycleAircon": false,
        "rumpusRoom": false,
        "secureParking": false,
        "splitSystemAircon": false,
        "splitSystemHeating": false,
        "tennisCourt": false,
        "vacuumSystem": false,
        "workshop": false,
        "study": false,
        "floorboards": false,
        "shed": false,
        "fullyFenced": false,
        "parkingSpaces": 1
      },
      "firstdate": "2024-09-11T03:53:15.000Z",
      "headline": "Comfort Style and Convenience",
      "id": 520756,
      "images": [
        {
          "id": "m",
          "url": "https://propertyimages.stepps.net/realestatewebsite/25428-residential-L30492221-1726027353qAAzzE.jpg",
          "type": "featured"
        },
        {
          "id": "a",
          "url": "https://propertyimages.stepps.net/realestatewebsite/25428-residential-L30492221-1726027353B7DrGs.jpg",
          "type": "img"
        },
        {
          "id": "b",
          "url": "https://propertyimages.stepps.net/realestatewebsite/25428-residential-L30492221-17260273536Ak7E3.jpg",
          "type": "img"
        }
      ],
      "inspectionTimes": [
        {
          "dateFrom": "2024-09-14T10:00:00.000Z",
          "dateTo": "2024-09-14T10:45:00.000Z"
        },
        {
          "dateFrom": "2024-09-18T10:00:00.000Z",
          "dateTo": "2024-09-18T10:45:00.000Z"
        },
        {
          "dateFrom": "2024-09-21T10:00:00.000Z",
          "dateTo": "2024-09-21T10:45:00.000Z"
        }
      ],
      "isOffMarket": false,
      "landCategory": "",
      "landDetails": {
        "area": {
          "value": 0,
          "unit": "squareMeter"
        },
        "frontage": {
          "value": 0,
          "unit": "meter"
        }
      },
      "listingType": "residential",
      "modtime": "2024-09-11T03:53:15.000Z",
      "newConstruction": false,
      "outgoings": "",
      "price": {
        "priceView": "For Sale: $875,000 - $900,000",
        "display": true,
        "value": 875000
      },
      "ruralCategory": "",
      "ruralFeatures": "",
      "status": "current",
      "tenancy": "",
      "underOffer": false,
      "updatedAt": "2024-09-11T04:02:36.107Z",
      "videoLinks": [],
      "vrTourLink": [],
      "propertyID": 420043,
      "website": {
        "_id": "664c2043954ff33272bb3ec0",
        "websiteID": 273,
        "logo": {
          "light": "https://realestatewebsite.com.au/logo-light.png",
          "dark": "https://realestatewebsite.com.au/logo-light.png",
          "override": ""
        },
        "favicon": "",
        "name": "Real Estate Website",
        "link": "https://realestatewebsite.com.au/",
        "type": "sub-account",
        "config": {
          "primaryColor": "#000000",
          "secondaryColor": "#f2f2f2",
          "tertiaryColor": "",
          "video": "",
          "cloudFrontCDN": "",
          "cloudFlareCDN": "",
          "listingTypes": {
            "hasForSale": true,
            "hasForRent": true
          }
        },
        "contacts": {
          "email": {
            "office": "admin@realestatewebsite.com.au",
            "sales": "",
            "pm": ""
          },
          "phone": {
            "office": "(02) 0000 0000",
            "sales": "",
            "pm": ""
          },
          "fax": {
            "office": "",
            "sales": "",
            "pm": ""
          }
        },
        "integrations": {
          "reviews": "default",
          "offmarketLink": "",
          "propertyEstimateLink": "",
          "propertyAppraisalLink": "",
          "switchToUsLink": "",
          "suburbProfileLink": "",
          "privacyPolicyLink": ""
        }
      },
      "slug": "/property/house-nsw-warriewood-l30492221",
      "link": "https://realestatewebsite.com.au/property/house-nsw-warriewood-l30492221/"
    }
  ]
}

Error Handling

The API uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted), and codes in the 5xx range indicate an error with our servers.

Code	Description
200	OK - The request was successful
400	Bad Request - The request was invalid or cannot be served
401	Unauthorized - The request requires authentication
403	Forbidden - The server understood the request but refuses to authorize it
404	Not Found - The requested resource could not be found
500	Internal Server Error - The server encountered an unexpected condition

For more information on using these endpoints, please refer to our Authentication Guide and Quick Start Guide.

Properties API Reference ​

List Properties ​

Query Parameters ​

Example Request ​

Example Response ​

Get a Single Property ​

Path Parameters ​

Example Request ​

Example Response ​

Error Handling ​

Properties API Reference

List Properties

Query Parameters

Example Request

Example Response

Get a Single Property

Path Parameters

Example Request

Example Response

Error Handling