Welcome to the RentalSource API
We recommend using our API to make it easier for property managers to maintain their listings.
To seamlessly maintain your listings on RentalSource, please follow these steps:
- Review our feed documentation & sample feed.
- Create your XML feed, which should only contain available properties.
- Ensure your feed updates automatically on a daily basis.
- Share the URL from which our feed indexer can fetch your feed.
- Once we accept your feed, it will be retrieved and processed every morning.
- You will receive a URL to access the daily updated feed processing report.
Our feed processor accepts the following listing data elements.
Item | Type | Required | Length | Description |
---|---|---|---|---|
action | string | required | 10 |
Identifies if a listing is being listed or removed. Accepted values:
|
id | string | required | 20 |
Unique numeric identifier for each item - e.g., your internal ID code. When you submit a feed, we check the id value to see if we already have the specific listing. If so, we update the listing with the new information instead of creating a new listing. If no listing exists with the id value, we create a new listing. Important:
|
updated | string | 19 |
Date when listing was last updated. Important:
|
|
type | string | required | 14 |
The type of property listing. Important:
|
street | string | required | 75 |
The street address of the property. Examples:
|
unit | string | 10 |
The unit number or name of the property. Examples:
|
|
city | string | 30 |
The city in which the property is located. Examples:
|
|
state | string | 2 |
The state abbreviation in which the property is located. Important:
|
|
zip | string | required | 7 |
The zip code in which the property is located. Examples:
|
latitude | string | 12 |
The latitude coordinate of where the property is located. Important:
|
|
longitude | string | 12 |
The longitude coordinate of where the property is located. Important:
|
|
contact_name | string | required | 50 |
The name of the person who is the main contact for the unit. Example:
|
contact_email | string | required | 75 |
The email address which listing leads will be sent to. It is not publicly viewable will not be used for any other purpose. Important:
|
contact_phone | string | 14 |
The main phone number used for listing inquiries. Example:
|
|
<units> <unit> name </unit> </units> |
string | 30 |
Brief description of the unit Examples:
|
|
<units> <unit> beds </unit> </units> |
int | 4 |
The number of beds in the unit. Important:
|
|
<units> <unit> baths </unit> </units> |
int | 5 |
The number of baths in the unit. Important:
|
|
<units> <unit> sqft </unit> </units> |
int | 6 |
The square footage (sqft) of the unit. Important:
|
|
<units> <unit> rent_min </unit> </units> |
int | 6 |
The minimum rental price of the unit. Important:
|
|
<units> <unit> rent_max </unit> </units> |
int | 6 |
The maximum rental price of the unit. Important:
|
|
<units> <unit> term </unit> </units> |
string | 5 |
The rental term. Important:
|
|
<amenities> amenity </amenities> |
string | 2 |
Used to describe the unit's amenities. Important:
|
|
<features> feature </features> |
string | 2 |
Used to describe the features of the community in which the property is located. Important:
|
|
<photos> <photo> description </photo> </photos> |
string | 30 |
Short description used to describe the photo. Shown when the photo is viewed. Examples:
|
|
<photos> <photo> url </photo> </photos> |
string | 125 |
Location of photo where RentalSource can download a copy to display on the listing. Important:
|
|
description | string | required | 5000 | This is the main description shown for your listing. |
terms | string | 1000 | Used to describe the lease terms of your property. | |
website | string | 125 |
If the property has a website, you may list the address here. Important:
|
This example demonstrates all of our available listing data elements for a listing. For more information, please review our feed documentation.
<xml> <properties> <property> <action>List</action> <id>1000</id> <updated>2024-03-29 05:41:21</updated> <expire>2024-06-29</expire> <type>House</type> <street>123 Birch Lane</street> <city>Raleigh</city> <state>NC</state> <zip>27615</zip> <latitude>35.875897</latitude> <longitude>-78.725046</longitude> <contact_name>Your Name</contact_name> <contact_email>your.name@company.com</contact_email> <contact_phone>(919) 555-1212</contact_phone> <units> <unit> <name>4 Bedroom</name> <beds>4</beds> <baths>2.5</baths> <sqft>2250</sqft> <rent_min>1250</rent_min> <rent_max>1500</rent_max> <term>Month</term> </unit> </units> <amenities> <amenity>ac</amenity> <amenity>bl</amenity> <amenity>cb</amenity> <amenity>cf</amenity> </amenities> <features> <feature>bp</feature> <feature>bo</feature> <feature>ch</feature> <feature>ca</feature> </features> <photos> <photo> <description>Front of home</description> <url>https://www.rentalsource.com/images/listings/1000-1.jpg</url> </photo> <photo> <description>Kitchen</description> <url>https://www.rentalsource.com/images/listings/1000-2.jpg</url> </photo> <photo> <description>Living Room</description> <url>https://www.rentalsource.com/images/listings/1000-3.jpg</url> </photo> </photos> <description>Insert description of rental property</description> <terms>Insert rental property lease terms</terms> <website>https://www.rentalsource.com/1000</website> </property> <property> ... </property> </properties> </xml>
RentalSource provides this API for non-commercial use and by using it you are agreeing to our Terms of Service.