Listing Descriptions

POST - /api/v2/listing-description

Inputs

• Unit (optional - string)

• Address (required - string)

• ListingType (required - sale or rent)

• Size (required - integer)

• SizeType (required - sqft, sqm, acres, or hectares)

• PropertyType (required - detached, semi, town, vacant, link, multiplex, condo, rural, lakeside, commercial, industrial or other)

• beds (optional - double)

• baths (optional -double)

• parking (optional - integer)

• Language (required - English-US, English-AU, English-CA, French-CA, French, Spanish, Punjabis, Cantonese, Mandarin, German, Ukranian, Portuguese, Arabic, Hindi, Punjabi, Dutch, Polish, Pirate, Russian)

• WordCount (optional - integer - defaults to 200)

• SpecialFeatures (optional - string - provide as json encoded array of strings)

Sample CURL request:

curl -X POST "https://api.mappedby.com/api/v2/listing-descriptions" \
     -H "Content-Type: application/json" \
     -d '{
         "Unit": "A",
         "Address": "123 Example Street",
         "ListingType": "sale",
         "Size": 1200,
         "SizeType": "sqft",
         "PropertyType": "detached",
         "beds": 3,
         "baths": 2,
         "parking": 1,
         "Language": "English-US",
         "WordCount": 250,
         "SpecialFeatures": "[\"Pool\", \"Gym\", \"Garden\"]"
     }'

Sample response:

{
    "status": "success",
    "description": "Introducing a stunning 3-bedroom, 2-bathroom detached home at 123 Example Street, Unit A. This spacious 1,200 sqft property offers a perfect blend of comfort and luxury with its exclusive features. Boasting an impressive outdoor pool, state-of-the-art gym, and beautifully landscaped garden, this property is perfect for those who desire a modern lifestyle. Don't miss out on this fantastic opportunity to make this dream home yours; schedule a private showing today!"
}

Note: Until you upgrade your account to a paid account, you will be restricted to making 1 request every hour.