Tenant.com Broker Feed & Tools API
For subscribers with many listings, we offer a batch upload feature that allows you to add/update your listings using an XML file format.
A list of batch upload subscribers and their activity can be found here.
How It Works
Your programmer sets up a special file on your server that we check and download every night. When you add more listings they get created on Tenant.com and when you delete or modify them in your file they get deleted or modified on Tenant.com.
This makes the process easier for you because you work with your existing system as you usually would and the edits happen on Tenant.com automatically.
How To Set Up Your Feed
- Sign up for an account on Tenant.com or sign-in to your existing Tenant.com account.
- Make sure you are marked as a Broker or Agent in the "My Account" section under "Account Info" section of the Tenant.com Homebase when you're logged in.
- Click on "My Batch Uploads" under "Broker Links"
- Follow the XML feed file format described here and create the XML file on your server.
- Enter the URL of the XML file on your server into the "URL of XML Batch Feed" field and make sure "Turn Batch Uploads" is maked "On".
- Click here to contact us at Tenant.com and let us know you added your feed so we can make sure everything is working.
- Enter your business information into the "Public Contact Info" under "Account Info", ensuring that "Include Me In The Tenant.com Public Directory" is checked so users can get an overview of all your listings at Tenant.com. Click here to see a sample Broker Directory listing.
- You listings will appear on Tenant.com in a few hours.
New Field! <oceanfront>1</oceanfront> - Assign value of 1 if the property is oceanfront.New Field! <saleprice>150000</saleprice> - Assign a value great than 0 and your listing will be consider a sale listing in addition to a rental if you so choose.New Field! <nofee>1</nofee> - Assign value of 1 and your listing will be considered a "No-Fee" listing. A no-fee listing is a listing that does not charge the tenant/renter any fees in addition to a standard application fee and credit check fee. Do not mark your listing as no fee if you will be charging a realtor, broker, move-in or any fee other than a credit or application fee.
The File Format
The XML document begins and ends with: <tenant> </tenant>
and each listing starts and ends with a: <listing> </listing>
After each listing, start and end field tags are populated with user entries. Field tags are in the following examples.
Requirements!
All listings in your feed:
- must have a contact email
- must have a contact phone number
- must have a contact home page
- should have a direct link to the property's page on the subscriber's site
- must be in valid XML format
Note! - The required contact info (above) can be set on the for all your listings by entering it in the"Public Contact Info" under "Account Info". The make sure all listings have good contact information, fill out "Public Contact Info" and then for more exact contact information you can always add additional contact information in each listing on your feed.
- the id field must contain a unique alpha-numeric value for each of your listings. This is typically your listing/key number in your database that uniquely identifies your listing. When we see new ids in your feed they get added to Tenant.com and when we see and existing id has been modified on your server the listing gets updated on Tenant.com.
- field tags should be lowercase.
- reserved characters - XML doesn't allow certain character to be included in the values so please use these abbreviations below instead:
- & should be &
- < should be <
- > should be >
- / should be #47;
- ] should be #93;
- [ should be #91;
- " should be #34;
- ' should be #39;
Note: You can also use CDATA to avoid the replacements above.
- General Fields
- Weekly/Vaction Listings Fields (plus all the General fields)
- Short Term Rental Fields (plus all the General fields)
Example Feeds:
- Standard Apartment/House/Yearly Rental
Notes: - Most fields are self-explanatory. However:
- affiliates - comma separated list of Tenant.com affiliate sites your listing may appear on:
- at - AtTheShore.com
- yr - YearlyRentals.com
- os - OnTheSlopes.com
- subtype - choose one of the following property types:
- Low Rise Apartment
- Mid Rise Apartment
- High Rise Apartment
- Apartment
- Brownstone
- Condo
- Co-op
- Cottage
- Duplex
- Loft
- Side-By-Side
- Studio
- Single Family
- Open Space
- Town Home
- Villa
- leasetype - field contains a comma separated list of lease options:
- mo - Monthly
- yr - Yearly
- st - Short Term
- lt - Long Term
- 1y - 1 Year
- 2y - 2 Year
- 3y - 3 Year
- 5y - 5 Year
- affiliates - comma separated list of Tenant.com affiliate sites your listing may appear on:
- Weekly Rental Example
Notes: - Most fields are self-explanatory. However:
- type - residential or commercial
- checkin is an offset for the checkin day (ie. 0=Saturday, 1=Sunday, -1=Friday, -2=Thursday, 2=Monday, 3=Wednesday)
- rate## is weeks 1 through 53 rates and descript## is descriptions 1 through 53. Our program assumes the first Saturday of the year for first date
- year - year for the rates. ie. 2006, 2007, ...
- affiliates - comma separated list of Tenant.com affiliate sites:
- at - AtTheShore.com
- wr - WeeklyRentals.com
- os - OnTheSlopes.com
- leasetype - comma separated list of lease terms:
- da - Daily
- we - Weekly
- wn - Weekends
- mv - Monthly Vacation
-
Short Term Rental Example
Notes: - Same fields like above are self-explanatory. However:
- id tag is a number ie. 1 through #. In this case 6. The id tag uniquely identifies that item. On updates we check for changes using this id. On subsequent uploads if id (say '1') is not in the batch, it will be deleted. On subsequent uploads if there is a new id (say '7'), a new short term rate will be added. Same id's that are subsequently uploaded, are checked for changes and if any are merged ...
- active - 1 is active, 0 is NOT active
- displayoncalendar - 1 is display rates on a yearly calendar, 0 is DO NOT ..
- priority is optional (0-9) for sorting. Sorts ascending order.
Calendars - Daily Rental Calendars are also available for update via the availabilitychart tag and these tags:
- period1 is a bitmap of the first 183 days of the year
- period2 is a bitmap of the second 183 days of the year
