RentalSource
RentalSource

Welcome to the RentalSource API

We recommend using our API to make it easier for property managers to maintain their listings.

Getting Started

To seamlessly maintain your listings on RentalSource, please follow these steps:

  1. Review our feed documentation & sample feed.
  2. Create your XML feed, which should only contain available properties.
  3. Ensure your feed updates automatically on a daily basis.
  4. Share the URL from which our feed indexer can fetch your feed.
  5. Once we accept your feed, it will be retrieved and processed every morning.
  6. You will receive a URL to access the daily updated feed processing report.
Note: If you already have a listing feed, we can use it to showcase your listings on RentalSource.
Feed Documentation

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:
  • List
  • Remove
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:
  • Once you submit an item with a unique id, this identifier must not change when you send in a new feed.
Examples:
  • Good: 1000
  • Good: A1000
  • Bad: 1,000
updated string   19

Date when listing was last updated.

Important:
  • If this field is not included, we will assume the listing has changed and process it.
Examples:
  • Good: 2023-11-30 15:10:18
  • Good: 2023-11-30 00:00:00
  • Bad: November 30, 2023
  • Bad: 2023-11-30
  • Bad: 20231130
type string required 14

The type of property listing.

Important:
  • Value used must be listed in "Accepted values"
Accepted values:
  • House
  • Apartment
  • Townhouse
  • Condo
  • Vacation
Examples:
  • Good: House
  • Bad: Home
street string required 75

The street address of the property.

Examples:
  • Good: 123 Birch Lane
  • Bad: Birch Lane
city string   30

The city in which the property is located.

Examples:
  • Good: Raleigh
state string   2

The state abbreviation in which the property is located.

Important:
  • Value used must be proper state/province abbreviation
Examples:
  • Good: NC
  • Bad: North Carolina
zip string required 7

The zip code in which the property is located.

Examples:
  • Good: 27615
  • Good: E2E 1C2
  • Bad: 27615-0714
latitude string   12

The latitude coordinate of where the property is located.

Important:
  • If blank, we will obtain the value from the listing address
Examples:
  • Good: 35.875897
  • Bad: 0
longitude string   12

The longitude coordinate of where the property is located.

Important:
  • If blank, we will obtain the value from the listing address
Examples:
  • Good: -78.725046
  • Bad: 0
contact_name string required 50

The name of the person who is the main contact for the unit.

Example:
  • Good: Joe Smith
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:
  • Value must be an acceptable email address
Example:
  • Good: info@rentalsource.com
  • Bad: https://www.rentalsource.com/
contact_phone string   14

The main phone number used for listing inquiries.

Example:
  • Good: (919) 987-1234
  • Bad: 919-987-1234
  • Bad: 9199871234
  • Bad: 886-345-RENT
  • Bad: 9871234
<units>
  <unit>
    name
  </unit>
</units> 		string   30

Brief description of the unit

Examples:
  • Good: 4 Bedroom
  • Good: The Roman
  • Bad: Please inquire!
<units>
  <unit>
    beds
  </unit>
</units> 		int   4

The number of beds in the unit.

Important:
  • Value must be numeric
  • If blank, value will default to "n/a"
Examples:
  • Good: 3
  • Good: 3.5
  • Bad: Three
<units>
  <unit>
    baths
  </unit>
</units> 		int   5

The number of baths in the unit.

Important:
  • Value must be numeric
  • If blank, value will default to "n/a"
Examples:
  • Good: 2
  • Good: 2.5
  • Bad: Two
<units>
  <unit>
    sqft
  </unit>
</units> 		int   6

The square footage (sqft) of the unit.

Important:
  • Value must be numeric
  • If blank, value will default to "n/a"
Examples:
  • Good: 1750
  • Bad: 1,750
<units>
  <unit>
    rent_min
  </unit>
</units> 		int   6

The minimum rental price of the unit.

Important:
  • Value must be numeric
  • If blank, value will default to "Please inquire"
Examples:
  • Good: 700
  • Good: 6000
  • Bad: $700
  • Bad: 700.99
<units>
  <unit>
    rent_max
  </unit>
</units> 		int   6

The maximum rental price of the unit.

Important:
  • Value must be numeric
  • If blank, value will default to value listed in "rent_min"
Examples:
  • Good: 700
  • Good: 6000
  • Bad: $700
  • Bad: 700.99
<units>
  <unit>
    term
  </unit>
</units> 		string   5

The rental term.

Important:
  • Value used must be listed in "Accepted values"
Accepted values:
  • Month
  • Week
  • Day
Examples:
  • Good: Week
  • Good: Month
  • Bad: daily
<amenities>
  amenity
</amenities> 		string   2

Used to describe the unit's amenities.

Important:
  • Value used must be listed in "Accepted values"
Accepted values:
  • ac - Air Conditioning
  • bl - Balcony/Patio
  • cb - Cable/Satellite TV
  • cf - Carpeted Floors
  • cl - Ceiling Fan
  • dw - Dishwasher
  • er - Electric Range
  • fp - Fireplace
  • fu - Furnished
  • ga - Garage
  • ds - Garbage Disposal
  • gr - Gas Range
  • hf - Hardwood Floors
  • in - High-Speed Internet
  • al - Intrusion Alarm
  • mw - Microwave
  • pa - Pets Allowed
  • rf - Refrigerator
  • ut - Utilities Paid
  • vc - Vaulted Ceilings
  • wk - Walk-in Closets
  • wh - Washer/Dryer Hk-up
  • wi - Washer/Dryer In Unit
  • wf - Waterfront Property
  • wc - Wheelchair Access
Examples:
  • Good: ac
  • Bad: Air Conditioning
<features>
  feature
</features> 		string   2

Used to describe the features of the community in which the property is located.

Important:
  • Value used must be listed in "Accepted values"
Accepted values:
  • bp - Bike Paths
  • bo - Boating
  • ch - Clubhouse
  • ca - Controlled Access
  • cy - Courtyard
  • fc - Fitness Center
  • gc - Golf Course
  • lr - Laundry Facilities
  • pp - Playground/Park
  • po - Pool
  • pt - Public Transportation
  • rp - Reserved Parking
  • ja - Spa/Jacuzzi
  • st - Storage
  • tc - Tennis Court
Examples:
  • Good: bp
  • Bad: Bike Paths
<photos>
  <photo>
    description
  </photo>
</photos> 		string   30

Short description used to describe the photo. Shown when the photo is viewed.

Examples:
  • Good: Master Bedroom
<photos>
  <photo>
    url
  </photo>
</photos> 		string   125

Location of photo where RentalSource can download a copy to display on the listing.

Important:
  • The photo must be in .jpg format
  • Value must be an acceptable url
Examples:
  • Good: https://www.rentalsource.com/images/1000.jpg
  • Bad: rentalsource.com/images/1000.jpg
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:
  • Value must be an acceptable website address
Examples:
  • Good: https://www.rentalsource.com/
  • Bad: rentalsource.com
Back to top
Sample Feed

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>2023-11-30 15:10:18</updated>
      <expire>2024-03-01</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>
Terms of Service

RentalSource provides this API for non-commercial use and by using it you are agreeing to our Terms of Service.

Back to top