Skip to main content

Get Real Estate List

The AI Agent API provides functionality to retrieve a list of real estate listings by sending a POST request to the /chat/Chatbot/RealEstateList endpoint.

Endpoint​

Request URL: https://usapi.hottask.com/chat/Chatbot/RealEstateList

Method: POST

Request Headers​

The API request must include the following headers:

  • chatrobot-sessionkey: <Your-Session-Key> - string, required - The session key for authenticating the API request (found on the Workspace -> Webhooks API -> chatrobot-sessionkey)

Request Body​

The request body should contain the following parameters:

{
  // string, required - The ID of the chatbot (found on the chatbot settings -> general -> chatbot ID)
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  // string, optional - Filter properties by city name
  "CityName": "Los Angeles",
  // string, optional - Must be one of: [for_sale, for_rent]
  "SaleType": "for_sale",
  // string, optional - Filter properties by MLS number
  "MLSNumber": "MLS123456",
  // integer, optional - Page number for pagination (default: 1)
  "PageNumber": 1,
  // integer, optional - Number of items per page (default: 20)
  "PageSize": 20
}
  • SerialNumber - string, required - The ID of the chatbot (found on the chatbot settings -> general -> chatbot ID)
  • CityName - string, optional - Filter properties by city name
  • SaleType - string, optional - Must be one of: [for_sale, for_rent]
  • MLSNumber - string, optional - Filter properties by MLS number
  • PageNumber - integer, optional - Page number for pagination (default: 1)
  • PageSize - integer, optional - Number of items per page (default: 20)

Example Request​

JavaScript (Fetch API)

const res = await fetch('https://usapi.hottask.com/chat/Chatbot/RealEstateList', {
  method: 'POST',
  headers: {
  "chatrobot-sessionkey": "<Your-Session-Key>"
},
  body: JSON.stringify({
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "CityName": "Los Angeles",
  "SaleType": "for_sale",
  "PageNumber": 1,
  "PageSize": 20
})
});

const data = await res.json();
console.log(data);

Python (Requests Library)

import requests
import json

url = 'https://usapi.hottask.com/chat/Chatbot/RealEstateList'
headers = {
    "chatrobot-sessionkey": "<Your-Session-Key>"
}
data = {
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "CityName": "Los Angeles",
  "SaleType": "for_sale",
  "PageNumber": 1,
  "PageSize": 20
}

response = requests.post(url, headers=headers, json=data)
data = response.json()
print(data)

cURL

curl 'https://usapi.hottask.com/chat/Chatbot/RealEstateList' \
  -X POST \
  -H 'chatrobot-sessionkey: <Your-Session-Key>' \
  -d '{"SerialNumber":"3254a9d0424c4806b9ea3d0763xxxxxx","CityName":"Los Angeles","SaleType":"for_sale","PageNumber":1,"PageSize":20}'

HTTP Request

POST /chat/Chatbot/RealEstateList HTTP/1.1
Host: usapi.hottask.com
chatrobot-sessionkey: <Your-Session-Key>

{
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "CityName": "Los Angeles",
  "SaleType": "for_sale",
  "PageNumber": 1,
  "PageSize": 20
}

Response​

The API response will be a JSON object with the following structure:

{
  // object - The response data
  "Data": {
    "List": [
      {
        "ID": 7459,
        "PropertyType": "Single Family Residential",
        "SaleType": "For Rent",
        "Status": "Active",
        "Images": "",
        "CurrencySymbol": "$",
        "Price": "80000.00",
        "State": "CA",
        "City": "Los Angeles",
        "Address": "123 Main St",
        "ZIP": "90001",
        "LATITUDE": 30.96,
        "LONGITUDE": -78.93,
        "Area": "Downtown",
        "Bathrooms": "4",
        "Bedrooms": "4",
        "Url": "https://example.com/property/123",
        "Tours": "3D",
        "YearBuilt": "2020",
        "MLSNumber": "MLS123456",
        "DaysOnMarket": "20",
        "LotArea": "800",
        "BuildingArea": "2500",
        "ParkingSpots": "8",
        "Description": "Beautiful property in prime location",
        "ExtensionColumn": "[{'Key':'Pool', 'value':'Yes'}]",
        "RentPrice": "80000.00",
        "SpaceType": "Entire place",
        "DepositFee": "5000.00",
        "SalePrice": "",
        "UnitAreaPrice": "",
        "ZestimatePrice": "",
        "HOAMonth": ""
      }
    ],
    "VirtualCount": 10
  },
  // string - API version
  "Version": "1.0.0",
  // boolean - Operation success status
  "Success": true,
  // integer - HTTP status code
  "Code": 200,
  // string - Error message if any
  "Message": ""
}

Error Handling​

If the request fails, you should: 1. Check the HTTP status code for network-level errors 2. Examine the `Code` and `Message` fields in the response for business-level errors 3. The `Message` field will contain detailed error information