ByOwnerMLS Feed Guidelines
The easiest
way to get your listings into ByOwnerMLS is to provide us with a data feed (a
file containing listings data). This file can exist on your server in a
location in which you give us access.
ByOwnerMLS Format:
Please note
that we generally require the full set of listings to be included in each feed
update. This allows us to expire those listings we have previously seen, but
which are no longer active in your inventory. We will access the file as often
as once per day unless you instruct
us differently. This will allow us to keep our database up to date.
Following
is the guideline to successfully integrate the partner listings into
ByOwnerMLS.com:
Example: http://www.mybyownerlistingsite.com/byownermlsintegration/data.xml
Where http://www.mybyownerlistingsite.com is the partner’s web site address,
byownermlsintegration/ is the
directory path to the data file and finally data.ml is the actual file containing the latest listings in the
xml format. (the URL, directory and file name may vary)
ByOwnerMLS.com XML
feed Format:
|
Tag Name |
Value Type |
|
Description of Field |
|||||||||||||||||||||||
|
<byownermls_feed> |
|
|
Root of the document |
|||||||||||||||||||||||
|
<listings> |
|
|
|
|||||||||||||||||||||||
|
<properties> |
|
|
Container for all the properties (Contains multiple
<property> tags) |
|||||||||||||||||||||||
|
<property> |
|
|
Property Listing |
|||||||||||||||||||||||
|
<name> |
|
Optional |
Generic heading of the property (see XML example below) |
|||||||||||||||||||||||
|
<address> |
|
Required |
This is a mandatory field. Address of property (Must be fuul address including the
street name and number and apartment if available). |
|||||||||||||||||||||||
|
<city> |
|
Required |
city or suburb |
|||||||||||||||||||||||
|
<state> |
|
Required |
|
|||||||||||||||||||||||
|
<country |
|
Required |
|
|||||||||||||||||||||||
|
<postcode> |
|
Required |
zip/postal code |
|||||||||||||||||||||||
|
<price> |
double |
Required |
multiple units and the price will range from min (price)
to Maximum (price_max) |
|||||||||||||||||||||||
|
<price_max> |
double |
Optional |
multiple units and the price will range from min (price)
to Maximum (price_max) |
|||||||||||||||||||||||
|
<lot_size> |
int |
Optional |
multiple units and the lot size will range from min
(lot_size) to Maximum (lot_size_max) |
|||||||||||||||||||||||
|
<lot_size_max> |
int |
Optional |
multiple units and the lot size will range from min
(lot_size) to Maximum (lot_size_max) |
|||||||||||||||||||||||
|
<sq_feet> |
int |
Optional |
multiple units and the square footage will range from min
(sq_feet) to Maximum (sq_feet_max) |
|||||||||||||||||||||||
|
<sq_feet_max> |
int |
Optional |
multiple units and the square footage will range from min
(sq_feet) to Maximum (sq_feet_max) |
|||||||||||||||||||||||
|
<garage_size> |
int |
Optional |
multiple units and the garage size will range from min
(garage_size) to Max (garage_size_max) |
|||||||||||||||||||||||
|
<garage_size_max> |
int |
Optional |
multiple units and the garage size will range from min
(garage_size) to Max (garage_size_max) |
|||||||||||||||||||||||
|
<no_beds> |
int |
Optional |
multiple units and the beds will range from min (no_beds)
to Max (no_beds_max) |
|||||||||||||||||||||||
|
<no_beds_max> |
int |
Optional |
multiple units and the beds will range from min (no_beds)
to Max (no_beds_max) |
|||||||||||||||||||||||
|
<no_baths> |
int |
Optional |
multiple units and baths will range from min (no_baths) to
Max (no_baths_max) |
|||||||||||||||||||||||
|
<no_baths_max> |
Varcar |
Optional |
multiple units and baths will range from min (no_baths) to
Max (no_baths_max) |
|||||||||||||||||||||||
|
<no_floors> |
Varcar |
Optional |
multiple units and the floors will range from min
(no_floors) to Max (no_floors_max) |
|||||||||||||||||||||||
|
<no_floors_max> |
Varcar |
Optional |
multiple units and the floors will range from min
(no_floors) to Max (no_floors_max) |
|||||||||||||||||||||||
|
<year_built> |
varcar |
Optional |
year the house was built |
|||||||||||||||||||||||
|
<amenities> |
text |
Optional |
list of house amenities |
|||||||||||||||||||||||
|
<school_district> |
varcar |
Optional |
The school district the house is in |
|||||||||||||||||||||||
|
<note> |
varcar |
Optional |
note to buyer or other information |
|||||||||||||||||||||||
|
<intro_text> |
varcar |
Optional |
title - before description; short overview of property if
any |
|||||||||||||||||||||||
|
<description> |
varcar |
Optional |
Full description of property ByOwnerMLS
would prefer as much descriptive information in the “description”
field about each listing as possible. The more information we have, the more
effective we can be at letting users find your listings. |
|||||||||||||||||||||||
|
|
|
|
|
|||||||||||||||||||||||
|
<type> |
|
Required |
Type of structure ONLY ONE MYST BE POSTED! When generating the xml please make sure that the property
type is assigned from the provided list. Only one <type> per property
can be passed, if multiple property types are passed it will be assigned on
first come bases, and the rest will be ignored. |
|||||||||||||||||||||||
|
|
|
|
|
|||||||||||||||||||||||
|
|
|
|
|
|||||||||||||||||||||||
|
<seller_name> |
|
Required |
Name of the property seller |
|||||||||||||||||||||||
|
<seller_phone> |
|
Required |
Primary phone of the property seller |
|||||||||||||||||||||||
|
<seller_other_phone> |
|
Optional |
Addl. Phone of the property seller |
|||||||||||||||||||||||
|
<seller_email> |
|
Required |
Sellers email address |
|||||||||||||||||||||||
|
<addl_url> |
|
Required |
home page, landing page for seller info, or other page URL |
|||||||||||||||||||||||
|
<ext_site_id> |
|
Required |
Unique property ID |
|||||||||||||||||||||||
|
<media> |
|
Optional |
Container for the listing related media files. (Images,
videos) |
|||||||||||||||||||||||
|
<photo> |
|
Optional |
Contains the URL to the property photo. |
|||||||||||||||||||||||
|
<video> |
|
Optional |
Contains the URL to the property video. |
|||||||||||||||||||||||
|
<status> |
Active/Pending/Sold/Reduced |
|
Listing status |
Example of the XML
Record:
<?xml
version="1.0" encoding="utf-8" ?>
<byownermls_feed>
<listings>
<properties>
<property>
<name>2190 Stockman Circle </name>
<address>2190 Stockman Circle </address>
<city>Folsom</city>
<state>CA</state>
<country>
<postcode>95630</postcode>
<price>510000.00</price>
<price_max></price_max>
<lot_size></lot_size>
<lot_size_max></lot_size_max>
<sq_feet>1600</sq_feet>
<sq_feet_max></sq_feet_max>
<garage_size>3</garage_size>
<garage_size_max></garage_size_max>
<no_beds>3</no_beds>
<no_beds_max></no_beds_max>
<no_baths>2</no_baths>
<no_baths_max></no_baths_max>
<no_floors>1</no_floors>
<no_floors_max></no_floors_max>
<year_built>1998</year_built>
<amenities>Fireplaces:1,
Heating:Forced Air, Cooling:Forced Air, WaterSupply:City Supplied,
Sewer:Sewer</amenities>
<school_district></school_district>
<note></note>
<intro_text></intro_text>
<description>
Located
in the prestigious Empire Ranch neighborhood, this 3/2 beauty has upgraded
carpet, tile, and cabinets throughout. Other features include a fully finished
back yard with a large patio, a fully finished 3-car garage, plantation blinds,
custom interior paint, and much more!
<description>
<propertytype>
<type>Single
family</type>
</propertytype>
<seller_name></seller_name>
<seller_phone></seller_phone>
<seller_other_phone></seller_other_phone>
<seller_email></seller_email>
<addl_url></addl_url>
<ext_site_id></ext_site_id>
<media>
<photo>http://www.myurl.com/myphotos/myphoto1.gif</photo>
<photo>http://www.myurl.com/myphotos/myphoto2.gif</photo>
</media>
<status>Active</status>
</property>
<property>
<name>2190 Stockman Circle </name>
<address>210 Main St </address>
<city>Orlando</city>
<state>FL</state>
<country>
<postcode>31230</postcode>
<price>519500.00</price>
<price_max></price_max>
<lot_size></lot_size>
<lot_size_max></lot_size_max>
<sq_feet>1600</sq_feet>
<sq_feet_max></sq_feet_max>
<garage_size>3</garage_size>
<garage_size_max></garage_size_max>
<no_beds>3</no_beds>
<no_beds_max></no_beds_max>
<no_baths>2</no_baths>
<no_baths_max></no_baths_max>
<no_floors>1</no_floors>
<no_floors_max></no_floors_max>
<year_built>1998</year_built>
<amenities>Fireplaces:1,
Heating:Forced Air, Cooling:Forced Air, WaterSupply:City Supplied,
Sewer:Sewer</amenities>
<school_district></school_district>
<note></note>
<intro_text></intro_text>
<description>
Located
in the prestigious Empire Ranch neighborhood, this 3/2 beauty has upgraded
carpet, tile, and cabinets throughout. Other features include a fully finished
back yard with a large patio, a fully finished 3-car garage, plantation blinds,
custom interior paint, and much more!
<description>
<propertytype>
<type>Single
family</type>
</propertytype>
<seller_name></seller_name>
<seller_phone></seller_phone>
<seller_other_phone></seller_other_phone>
<seller_email></seller_email>
<addl_url></addl_url>
<ext_site_id></ext_site_id>
<media>
<photo>http://www.myurl.com/myphotos/myphoto1.gif</photo>
<photo>http://www.myurl.com/myphotos/myphoto2.gif</photo>
</media>
<status>Active</status>
</property>
</properties>
</listings>
</byownermls_feed>