Aussie Property Finder
Aussie Property Finder · Actions GPT
Call APIs to get data for GPTs
Grab data from AI Space
POST /propertyAPI/forGPTs/listingSearchsearchListGet the property listing based on various features such as postcode, suburb, number of bedrooms, bathrooms, swimming pool, land size, and other specific characteristics
POST /propertyAPI/forGPTs/propertyDetailsgetPropertyDetailsRetrieve detailed or related information about a specific property based on its address. This can include property condition, historical data, valuation, and other related details.
POST /propertyAPI/forGPTs/searchAgencysearchAgencySearch for agencies or agents by their name, address, suburb, postcode, or mobile.
POST /propertyAPI/forGPTs/imageAnalysisimageAnalysisReceive and process the analysis of an uploaded image.
Schéma original API
{
"openapi": "3.1.0",
"info": {
"title": "Call APIs to get data for GPTs",
"description": "Grab data from AI Space",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://aiall.space"
}
],
"paths": {
"/propertyAPI/forGPTs/listingSearch": {
"post": {
"description": "Get the property listing based on various features such as postcode, suburb, number of bedrooms, bathrooms, swimming pool, land size, and other specific characteristics",
"operationId": "searchList",
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postcode": {
"type": "string",
"description": "Post code of the user asking"
},
"suburb": {
"type": "string",
"description": "Suburb of the user asking"
},
"around": {
"type": "boolean",
"description": "if user ask not only for specified suburb, but also around it"
},
"newest": {
"type": "boolean",
"description": "if user ask the newest or recently listing properties"
},
"newestDays": {
"type": "number",
"description": "user ask how many days newest listing properties"
},
"sold": {
"type": "boolean",
"description": "if user ask the sold properties"
},
"inspectionStartDateTime": {
"type": "string",
"description": "if user ask when can inspect the property"
},
"inspectionEndDateTime": {
"type": "string",
"description": "if user ask when can inspect the property"
},
"beds": {
"type": "integer",
"description": "Number of bedrooms in the property"
},
"baths": {
"type": "integer",
"description": "Number of bathrooms in the property"
},
"swimmingPool": {
"type": "boolean",
"description": "Whether the property has a swimming pool"
},
"landSizeMin": {
"type": "integer",
"description": "Minimum land size of the property in square meters"
},
"landSizeMax": {
"type": "integer",
"description": "Maximum land size of the property in square meters"
},
"priceMin": {
"type": "integer",
"description": "Minimum land price of the property"
},
"priceMax": {
"type": "integer",
"description": "Maximum land price of the property"
},
"cars": {
"type": "boolean",
"description": "Whether the property has parking facilities"
},
"garden": {
"type": "boolean",
"description": "Whether the property has a garden"
},
"propertyAge": {
"type": "integer",
"description": "Age of the property in years"
},
"schoolNames": {
"type": "array",
"description": "school names of user question",
"items": {
"type": "string"
}
},
"inSchoolCatchment": {
"type": "boolean",
"description": "if provide school name, means need to find the properties inside school catchment ."
},
"propertyType": {
"type": "array",
"description": "Types of property (e.g., apartment, house, villa)",
"items": {
"type": "string",
"enum": [
"acreage semi",
"diary",
"house",
"apartment",
"unit",
"alpine",
"cropping",
"duplex semi",
"farmlet",
"flat",
"horticulture",
"lifestyle",
"livestock",
"mixed farming",
"other",
"residential land",
"retirement living",
"serviced apartment",
"studio",
"terrace",
"townhouse",
"unitblock"
]
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response with property listing information",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"viewMorePropertiesLink": {
"type": "string",
"description": "URL to view more properties on a map",
"example": "https://aiall.space/properties/map-view?suburb={suburb}&postcode={postcode}&beds={beds}&baths={baths}"
},
"subscriptionInvite": {
"type": "string",
"example": "Would you like to receive the latest property listings for your interested suburbs directly in your inbox? Leave your email or mobile number to subscribe to our updates!"
}
}
}
}
}
}
}
}
},
"/propertyAPI/forGPTs/propertyDetails": {
"post": {
"description": "Retrieve detailed or related information about a specific property based on its address. This can include property condition, historical data, valuation, and other related details.",
"operationId": "getPropertyDetails",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "this address is the user input address which should be converted to address includes street number, street, suburbs, postcode , and state, if user not type suburb/state/postcode or typo or wrong, please include and correct it"
},
"detailsType": {
"type": "array",
"description": "Types of details requested about the property.",
"items": {
"type": "string",
"enum": [
"condition",
"history",
"valuation",
"neighborhood",
"marketTrends",
"schoolcatchment",
"general"
]
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response with detailed information about the specified property.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"propertyDetails": {
"type": "object",
"description": "A detailed object containing the requested information about the property.",
"properties": null
}
}
}
}
}
},
"404": {
"description": "Property not found or address incorrect.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "The property could not be found. Please verify the address and try again."
}
}
}
}
}
}
}
}
},
"/propertyAPI/forGPTs/searchAgency": {
"post": {
"description": "Search for agencies or agents by their name, address, suburb, postcode, or mobile.",
"operationId": "searchAgency",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"agencyName": {
"type": "string",
"description": "Name of the agency"
},
"agentName": {
"type": "string",
"description": "Name of the agent"
},
"address": {
"type": "string",
"description": "Address of the agency or agent"
},
"suburb": {
"type": "string",
"description": "Suburb where the agency or agent is located"
},
"postcode": {
"type": "string",
"description": "Postcode of the agency's or agent's location"
},
"mobile": {
"type": "string",
"description": "Mobile number of the agency or agent"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response with agency or agent information",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": null
}
}
}
}
}
}
},
"/propertyAPI/forGPTs/imageAnalysis": {
"post": {
"description": "Receive and process the analysis of an uploaded image.",
"operationId": "imageAnalysis",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"imageAnalysisResult": {
"type": "string",
"description": "The GPT analysis result of the uploaded image"
},
"additionalInfo": {
"type": "object",
"description": "Any additional information related to the image or analysis",
"properties": {
"uploadTime": {
"type": "string",
"format": "date-time",
"description": "The time when the image was uploaded"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response acknowledging the receipt of the image analysis",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Confirmation message or further instructions"
}
}
}
}
}
}
}
}
}
}
}