Listing Description API
This API provides a way to generate AI-based descriptions for real estate listings. It takes various attributes of the property as inputs and uses them to generate a detailed and attractive descriptio
HTTP Method: POST
Endpoint: https://api.listingai.co/v2/create-description
Example usage: A JSFiddle is provided here: https://jsfiddle.net/listingai/3yr492ah/
Headers:
Authorization: Bearer <Your_API_Token>
Note: Replace <Your_API_Token>
with the provided authorization token. If you do not provide a token, you can still text the API but it will only work the the address "152 Strachan Ave Toronto Ontario M6J2S9 Canada
Body Parameters:
Parameter | Type | Description | Required |
---|---|---|---|
address | String | The address of the property. | Yes |
propertyType | String | The type of property. We suggest using values of "deatched", "row", "apparement","flat","condo","townhouse", "vacant-land", "commercial", "industrial". You can provide other values as long as they are sufficiently descriptive. | Yes |
transactionType | String | The type of transaction intended for the property Suggested values are "For sale" or "For rent". You can provide other values as long as they are sufficiently descriptive. | Yes |
numberOfBathrooms | Number | The total number of bathrooms in the property. This should be an integer. If there are none, provide "0". | Yes |
numberOfBedrooms | Number | The total number of bedrooms in the property. This should be an integer. If there are none, provide "0". | Yes |
numberOfParkingSpaces | Number | The total number of parking spaces available in the property. This should be an integer. If there are none, provide "0". | Yes |
additionalDetails | String | Additional information about the property that could be beneficial to include in the description. This is a free text area. You can provde any notes you feel are relevant. | No |
area | Number | The total area of the interior space of the property This should be a value representing a square figure such as "2500" or "250" etc. | No |
areaUnit | String | The unit of measurement for the area of the property. Suggeste values are sqft or sqm. | No |
lotSize | String | The size of the land the property is located on. You can provide dimensions such as "10x30" or square figures such as "2500" | No |
lotSizeUnit | String | The unit of measurement for the lot size. Suggested values are acres, sqm, sqft, hectares | No |
writingStyle | String | The style in which the description should be written. Acceptable values are Neutral, creative, professional | Yes |
wordCount | Number | The approximate number of words to be used in the description. Word limit is 500 You must provide either this field OR the characterCount field | No see description |
characterCount | Number | The approximate number of characters to be used in the description. Character limit is 2000 You must provide either this field OR the wordCount field | No see description |
language | String | The language in which the description should be generated. Any ISO 639 language code and ISO 3166-1 Alpha-2 country code i.e. en-US, en-UK, fr-CA | Yes |
Response:
The response will be an AI-generated real estate description based on the input parameters.
Last updated