|
|
Send a Listings Feed
<< back to feed page
Sample Rental Housing Feed Files
Oodle accepts rental housing feed files in the CSV, Tab-Delimited, or XML formats. Here is a sample feed file for each of these formats:
CSV
Tab-Delimited
XML
Rental Housing Fields
Required Fields
Each rental housing listing needs to include these fields.
Location Fields
The location fields indicate the location of the item being listed. For location-based search to work, it is highly recommended that each listing specify its location at least down to the city or zip/postal code level.
Additional Fields
The more of these additional fields that are included for a listing, the more likely that listing is to be found in searches.
Field Descriptions
| address |
| The street address of the listing. |
|
Format:
Text.
|
|
Example:
3459 Oak Street
|
| amenities |
| The set of amenities possessed by the residential unit or residential complex. |
|
Format:
Text. Allowed values include: AC, alarm, basketball, cable, clubhouse, dishwasher, doorman, elevator, fireplace, gated, gym, hot tub, internet, parking, patio, playground, pool, refrigerator, satellite, storage, TV, tennis, washer dryer, wood floors. Any number of these may be included, separated by commas.
|
|
Example:
cable, fireplace, internet, parking, refrigerator, washer dryer
|
| balconies |
| The number of balconies. |
|
Format:
Number.
|
|
Example:
3
|
| bathrooms |
| The number of bathrooms. A half-bathroom can be indicated by adding .5 to the number of full bathrooms. |
|
Format:
Number.
|
|
Example:
2
|
| bedrooms |
| The number of bedrooms. |
|
Format:
Number.
|
|
Example:
3
|
| category |
| The category of the item being listed. Here are some such categories. |
|
Format:
Text. Please be consistent in category names.
|
|
Example:
Apartments For Rent
|
| city |
| The name of the city. Please use an official postal city name. |
|
Format:
Text.
|
|
Example:
Concord
|
| country |
| The country abbreviation. |
Format:
Text. Preferably, the two letter ISO 3166 country code. |
|
Example:
US
|
| create_time |
| The date/time at which the listing was created. |
|
Format:
YYYY-MM-DD, or RSS format (i.e. 2004-07-16T14:00:00-07:00).
|
|
Example:
2004-07-16T14:00:00-07:00
|
| currency |
| The ISO 4217 three-letter currency code for the currency used in this listing. |
|
Format:
Text. By default, such fields as price and salary are assumed to be specified in the currency of the country the listing is located in, and this is sufficient for the vast majority of listings. Use this field to override this assumption.
|
|
Example:
USD
|
| description |
| A description of the listing. |
|
Format:
Text. Maximum length 20,000 bytes.
|
|
Example:
Spacious three bedroom, two bathroom apartment for rent in the Willow Park neighborhood of Concord.
|
| event_date |
| The date/tiem of an Open House. |
|
Format:
YYYY-MM-DD, or RSS format (i.e. 2004-12-16T14:00:00-07:00).
|
|
Example:
2004-09-16
|
| expire_time |
| The date/time at which the listing expires. |
|
Format:
YYYY-MM-DD, or RSS format (i.e. 2004-09-16T14:00:00-07:00).
|
|
Example:
2004-09-16T14:00:00-07:00
|
| facing |
| The direction the front of the unit faces. |
|
Format:
Text. Allowed values are: north, northwest, west, southwest, south, southeast, east, northeast.
|
|
Example:
north
|
| featured |
| Indicates that a particular listing should be featured. This field only works if prior arrangements have been made with Oodle. |
|
Format:
Text. Allowed values are: yes, no.
|
|
Example:
yes
|
| fee |
| Listing requires a fee to view the content (ie. requires registering at a fee-based site). |
|
Format:
Text. Allowed values are: yes, no.
|
|
Example:
yes
|
| furnished |
| The furnishings that will be included with the place being listed. |
|
Format:
Text. Allowed values are furnished, partly furnished and unfurnished.
|
|
Example:
Partly Furnished
|
| id |
| Unique ID for this listing. You must use the same id with a listing in subsequent versions of the feed. |
|
Format:
Text.
|
|
Example:
3916251
|
| image_url |
| A URL pointing to a full-sized (not thumbnail) image of the item being listed. We will reduce the image to an appropriately-sized thumbnail. The image should be specifically relevant to the item being listed, so please do *not* include logos nor 'image unavailable' images. Multiple image URLs can be included by pipe-separating the URLs. |
|
Format:
Fully qualified URL(s) that points to an image.
|
|
Example:
http://www.example.com/listing/image1.jpg|http://www.example.com/listing/image2.jpg
|
| ip_address |
| The IP address of the user that the listing was posted from. |
|
Format:
IPv4 address in dot-decimal notation.
|
|
Example:
142.72.8.120
|
| latitude |
| Latitude, in degrees. |
|
Format:
Number.
|
|
Example:
37.5537
|
| longitude |
| Longitude, in degrees. |
|
Format:
Number.
|
|
Example:
-122.3038
|
| lot_size |
| The size of the lot, in square feet, unless acres are specified. |
|
Format:
Number, optionally followed by one of: square feet, acres. (The singular version: acre is also accepted.)
|
|
Example:
4 acres
|
| lot_size_units |
| The type of unit the lot size is specified in. |
|
Format:
Text. Allowed values are: square feet, acres. (The singular version: acre is also accepted.)
|
|
Example:
acres
|
| max_price |
| The maximum price for the specific floor plan in the apartment complex. |
|
Format:
Floating-point number. Please use the an optional decimal point (.), rather than the comma, to indicate cents. If a dash (-) is included between two such numbers, then the price is treated as a price range.
|
|
Example:
1550.00
|
| min_price |
| The minimum price for the specific floor plan in the apartment complex. |
|
Format:
Floating-point number. Please use the an optional decimal point (.), rather than the comma, to indicate cents. If a dash (-) is included between two such numbers, then the price is treated as a price range.
|
|
Example:
1200.00
|
| neighborhood |
| Neighborhood name. |
|
Format:
Text.
|
|
Example:
Willow Park
|
| number_available |
| The number of units available in the apartment complex. |
|
Format:
Number.
|
|
Example:
2
|
| pets_allowed |
| Types of pets allowed. |
|
Format:
Text. Allowed values are: none, dogs, cats, dogs and cats.
|
|
Example:
cats
|
| price |
| The price of the listing. Note that a price of zero (0) means free. If the price is unknown or not specified, then do not include this field or leave it blank. For auction items this should be the buy-it-now price. |
|
Format:
Floating-point number. Please use the an optional decimal point (.), rather than the comma, to indicate cents. If a dash (-) is included between two such numbers, then the price is treated as a price range.
|
|
Example:
1550.00
|
| price_type |
| The length of time to which the price of this rental applies. Especially useful for vacation rentals. |
|
Format:
Text. Allowed values are: daily, weekly, monthly, yearly.
|
|
Example:
monthly
|
| registration |
| Listing requires registering at a site to view the content. |
|
Format:
Text. Allowed values are: yes, no.
|
|
Example:
yes
|
| secondary_source |
| The name of the original source of the listings, if it is other than the provider of this feed. |
|
Format:
Text.
|
|
Example:
Pleasanton Listings
|
| seller_email |
| The email of the actual seller of the listing. |
|
Format:
Text.
|
|
Example:
joe@smith.com
|
| seller_name |
| The name of the actual seller of the listing. |
|
Format:
Text.
|
|
Example:
Joe Smith
|
| seller_phone |
| The phone number of the actual seller of the listing. |
|
Format:
Text.
|
|
Example:
123-456-7890
|
| seller_url |
| The URL of the actual seller of the listing. |
|
Format:
Fully qualified url.
|
|
Example:
http://smith-classifieds.com/
|
| square_feet |
| The number of usable square feet in the unit being listed. |
|
Format:
Number.
|
|
Example:
2400
|
| state |
| The abbreviation for the province or state. |
|
Format:
Text. Please use standard abbreviations where possible.
|
|
Example:
CA
|
| title |
| The title of the listing. |
|
Format:
Text.
|
|
Example:
Spacious Apartment for Rent
|
| url |
| The URL of the details page for this listing. This URL must have relevent information about the listing. |
|
Format:
Fully qualified url.
|
|
Example:
http://www.example.com/listing/details.html
|
| vastu_compliant |
| Whether the place of residence is Vastu compliant (used in India). |
|
Format:
Text. Allowed values are: yes, no.
|
|
Example:
yes
|
| zip_code |
| The postal code or zip code of the listing. |
|
Format:
Text. Please use a format standard to the postal codes of the country in question.
|
|
Example:
94772
|
<< back to feed page
|
