API Data Fields

API Data Fields

Using the API to add a property to your account.

Streamline your property uploads and synchronize your real estate portfolio effortlessly with our robust API.
Designed for seamless integration, the ADVSR.ai API empowers you to automate the transfer of listings directly from your CRM to our platform, ensuring your properties are showcased globally with minimal effort. Embrace the convenience of POST requests to keep your offerings up-to-date and at the forefront of the market. Explore our documentation below to unlock a more efficient, connected future for your real estate business.
An example API request, the API Keys are specific to individual user identified by their email address, and can take an array of properties allowing multiple properties to added in a single request.


API Data Fields



Key
          required
  type
Value
Example
                                                      id
          no
   number
  Optional property id property which  if added updates a property. If ommited ie parameter not passed, then instead we create a new property. Navigate to a users microsite and you can find the property id for a property in the URL https://danieldaggers.advsr.ai/property/benahavis/la-zagaleta/938 which has an id of 938

email
           yes
   string (email)
{user email]
elliot@advsr.ai
api_key
           yes
  string
(required) [user API key]
Request your API key from hi@advsr.ai
is_rental
           yes
   enum (0,1)
(required)  0=No
1=Yes

name
          yes
  string 
(required) 

property_type_id
         yes
  enum (1,2,3,4,5,6,7 or 8)
(required)  1= Apartment
2= Villa
3= Semi-Detached House
4= Detached House
5= Terraced House
6= House
7= Commercial Property
8= "New Development"

property_status
         yes
   enum (0,1)
(required)  0=
1=

price_qualifier
        yes 
 enum (see values)
(required) Available price qualifiers are the following strings:   'POA',  'Sale by Tender',  'Part Buy', 'Part Rent',     'Coming Soon', 'For Sale By Auction',  'Guide Price',            'Fixed Price',
 'Offers in excess of’,  'OIRO',  'From',  'Shared Ownership',  'Offers over', 
 'Shared Equity'

currency
yes

[ISO Currency Code]
GBP,USD
price
yes


1500000
beds
yes
      number


bath
yes
       number


key_feature_{1...6}
yes
       string

Swimming Pool, Gaggenau Appliances
land_area
yes
        number
                                     These are square feet by api only
2000
internal_area
yes
       number

                                         These are square feet by api only

1500
town
yes
        string
max 100 chars
9th Arrondissement
city
yes
       enum
list of allowed countries can be found by looking at /account/property-upload and seeing the cities drop down
Paris
postcode
yes
          

90210
country
yes
         enum
list of allowed countries can be found by looking at /account/property-upload and seeing the countries drop down. 
USA
description
yes
      string
                                             max of 400 words

media_urls
yes
       string array
array with public urls our service will download, to a max of 35, required but may be empty if no photos 
Photo URLs
floor_plan_urls
yes 
      string array
array with public urls our service will download required but may be empty if no photos 

                   standar_referal_fee
     no
       number
                                                 the percentage standard refferal fee position of the property. 

                           is_off_market 
   yes
        enum
                  0 or 1 where 1 is off-market, and 0 is on market. defaults to 0. 


POST Request Example - Single

`const data = {
email: 'elliot@advsr.ai',
api_key: '123456abcdef',
properties: [
{
is_rental: 0,
name: 'A Great Property In California',
property_type_id: 6,
property_status: 0,
price_qualifier: 'Fixed Price',
currency: 'USD',
price: 3000000,
beds: 3, 
key_feature_1 : Wonderful swimming pool, 
key_feature_2 : Large Sauna, 
key_feature_3 : Sea Views, 
key_feature_4 : Beach Access, 
key_feature_5 : Ample Private Parking,
key_feature_6 : Large Private Garden,
land_area: 10000,
internal_area: 2000,
town: 'London',
city: 'The Big City',
postcode: 'NW1',
country: 'United Kingdom',
description: 'Lorum Ipsum Sum',
media_urls: [
],
floor_plan_urls: [
]
}
],
};

fetch('advsr.ai/api/addProperty', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => {
console.log('Success:', data);
})
.catch(error => {
console.error('Error:', error);
});`

notes:



    • Related Articles

    • I didnt sign up for ADVSR.ai. Why do i have a microsite?

      We understand your concern regarding the source and storage of your data. The user data we have collected primarily comes from publicly available sources and is used to enhance your experience on our platform. We want to assure you that we take data ...

    • How does ADVSR.ai work for real estate developers?

      ADVSR.ai offers real estate developers a powerful platform to enhance their real estate marketing efforts and reach a global audience of potential buyers. Here's how it works for developers: Exposure to a Global Network: Developers can showcase their ...

    • TUTORIAL - How to Set Up Your Profile on ADVSR.ai?

      Step 1: Sign In to Your Account If you haven't already, sign up for an account on ADVSR.ai. Once registered, sign in using your credentials. Step 2: Access Your Account Settings Locate the navigation bar at the top of the page. Click on the 'MY ...