API Documentation

Here are the elements that are accepted by our API.

Item Type Required Length Description
vendor string required 50 Sign up to receive your vendor key
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: 2016-12-08 18:57:09
  • Good: 2016-12-08 00:00:00
  • Bad: December 08, 2016
  • Bad: 2016-12-08
  • Bad: 20161208
expire string   10

Date when listing can be automatically removed from our system.

Important:
  • If this field is not included, you will need to submit a separate "Remove" request to remove it.
Examples:
  • Good: 2016-12-08
  • Bad: December 08, 2016
  • Bad: 20161208
type string required 14

The type of property listing.

Important:
  • Value used must be listed in "Accepted values"
Accepted values:
  • Apartment
  • Condo
  • Single-Family Home
  • Townhouse
  • Vacation
Examples:
  • Good: Apartment
  • Good: Vacation
  • Bad: House
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: Ashley Morgan
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: http://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
contact_phone_alt string   14

The secondary phone number used for listing inquiries.

Example:
  • Good: (919) 987-1234
  • Bad: 919-987-1234
  • Bad: 9199871234
  • Bad: 9871234
contact_fax string   14

The fax number used for listing inquiries.

Example:
  • Good: (919) 987-1234
  • Bad: 919-987-1234
  • Bad: 9199871234
  • Bad: 9871234
<floorplans>
  <floorplan>
    name
  </floorplan>
</floorplans>
string   30

Brief description of the floorplan

Examples:
  • Good: 4 Bedroom
  • Good: The Roman
  • Bad: Please inquire!
<floorplans>
  <floorplan>
    beds
  </floorplan>
</floorplans>
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
<floorplans>
  <floorplan>
    baths
  </floorplan>
</floorplans>
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
<floorplans>
  <floorplan>
    sqft
  </floorplan>
</floorplans>
int   6

The square footage of the unit.

Important:
  • Value must be numeric
  • If blank, value will default to "n/a"
Examples:
  • Good: 1750
  • Bad: 1,750
<floorplans>
  <floorplan>
    rent_min
  </floorplan>
</floorplans>
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
<floorplans>
  <floorplan>
    rent_max
  </floorplan>
</floorplans>
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
<floorplans>
  <floorplan>
    term
  </floorplan>
</floorplans>
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
<pictures>
  <picture>
    description
  </picture>
</pictures>
string   30

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

Examples:
  • Good: Master Bedroom
<pictures>
  <picture>
    url
  </picture>
</pictures>
string   125

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

Important:
  • The picture must be in .jpg format
  • Value must be an acceptable url
Examples:
  • Good: http://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: http://www.rentalsource.com/
  • Bad: rentalsource.com