CONTENTS
OVERVIEW
Only include exclusive listings. Open listings and limited listings should not be included
The StreetEasy Feed Format is a simple XML format that allows us to index your listings and have them appear on our site. The format is flexible, but designed for quick implementation, many of the fields are optional.
When you are implementing the feed you should note the following:
- Make this feed available on your website via HTTP, we can accept feeds through other methods, but this is the easiest integration.
- Make sure to encode any special characters in the text of your feed, these include ‘<‘ to ‘>’ and ‘>’ to ‘<’
- We will request the feed every three hours, or more often if requested.
- The feed should contain a list of all properties currently available/in contract. Any properties that we do not find in the feed will be assumed to be off market.
- Please use CDATA in the listing description to mark line breaks in the text e.g. <br>
If you already have an existing feed we can probably accept the feed as-is. Contact us and we will work with you to have it integrated into our site.
XML FEED FORMAT
<?xml version="1.0" encoding="UTF-8"?> <streeteasy version="1.6"> <properties> <property type="rental|sale" status="active|off-market|temp-off-market|in-contract|contract-out|contract-signed|sold|rented" id="unique id" url="external url for the property"> <location> <address/> <apartment/> <city/> <state/> <zipcode/> <neighborhood/> </location> <details> <price/> <!-- We can accept rental period pricing for seasonal rentals. Ensure property type is rental and price attribute above is blank --> <rental_period_pricing> <md_ld/> <!-- for Memorial Day to Labor Day --> <june/> <!-- for June --> <july/> <!-- for July --> <august/> <!-- for August --> <august_ld/> <!-- for August - Labor Day --> <july_ld/> <!-- for July - Labor Day --> <june_july/> <!-- for June - July --> <july_august/> <!-- for July - August --> <extended_season/> <!-- for Extended Season pricing --> <year_round/> <!-- for Year Round pricing --> <winter/> <!-- for Winter pricing --> <short_term/> <!-- for Short Term pricing --> </rental_period_pricing> <noFee/> <!-- include if no fee --> <maintenance/> <!-- monthly (Also Common Charges for condos) --> <max_financing/> <!-- Max financing option --> <exclusive/> <!-- Include this tag if this is an exclusive listing --> <taxes/> <!-- monthly --> <bedrooms/> <bathrooms/> <totalrooms/> <!-- total # rooms in the property --> <squareFeet/> <availableOn> <!-- rental only --> <listedOn/> <soldOn/> <description/> <propertyType>condo|coop|townhouse|condop|rental|house|other</propertyType> <mlsId></mlsId> <mlsName></mlsName> <built/> <amenities> <!-- include all that apply --> <doorman/> <gym/> <pool/> <elevator/> <garage/> <parking/> <balcony/> <storage/> <patio/> <!-- Outdoor space --> <fireplace/> <washerDryer/> <dishwasher/> <furnished/> <pets/> <other/> <!-- A comma delimited string of other amenities --> </amenities> </details> <openHouses> <openHouse> <startsAt/> <endsAt/> <apptOnly/> </openHouse> </openHouses> <agents> <agent id=""> <!-- If agents have a unique id in your system put that here --> <name/> <company/> <photo/> <!-- URL of the agent photo --> <url/> <!-- Brokers personal page --> <email/> <lead_email/> <!-- If you have a lead generation email, this email address can put here --> <phone_numbers> <main/> <office/> <cell/> <fax/> </phone_numbers> </agent> </agents> <media> <!-- Multiple pictures, video and otherMedia allowed--> <photo url="" description="" position="x" /> <photo url="" description="" position="y" /> <floorplan url="" description=""/> <video url="" description=""/> <otherMedia url="" description=""> </media> </property> </properties> </streeteasy>
SAMPLE FEED
<?xml version="1.0" encoding="UTF-8"?> <streeteasy version="1.6"> <properties> <property status="active" type="sale" id="296321" url="http://www.eastsiderealty.com/listing.php?id=296321"> <location> <address>15 East 14th Street</address> <apartment>4H</apartment> <city>New York</city> <state>NY</state> <zipcode>10016</zipcode> <neighborhood>Flatiron</neighborhood> </location> <details> <mlsName>Tri-State MLS</mlsName> <mlsId>1273371</mlsId> <price>1595000</price> <maintenance>1159.0</maintenance> <max_financing>80</max_financing> <exclusive/> <taxes>889.0</taxes> <bedrooms>2</bedrooms> <bathrooms>1</bathrooms> <totalrooms>4</totalrooms> <squareFeet>850</squareFeet> <listedOn>2006-06-21</listedOn> <description> <![CDATA[ Dazzling million dollar panoramic views include the East River and downtown NYC. Pristine convertible two bed / two bath plus powder room condo. Upon entering, your eyes focus on the views from oversized windows facing east and south.<br /><br /> Listings like this don't last long. Contact us today!<br /> ]]> </description> <propertyType>Condo</propertyType> <amenities> <doorman /> <prewar /> <other>salt water lap pool, media room</other> </amenities> </details> <openHouses> <openHouse> <startsAt>2007-05-13 1:00PM</startsAt> <endsAt>2007-05-13 3:00PM</endsAt> <apptOnly></apptOnly> </openHouse> </openHouses> <media> <photo url="http://www.eastsiderealty.com/img/296321_int_photo1.jpg"/> <photo url="http://www.eastsiderealty.com/img/296321_int_photo2.jpg"/> <photo url="http://www.eastsiderealty.com/img/296321_int_photo3.jpg"/> <photo url="http://www.eastsiderealty.com/img/296321_int_photo4.jpg"/> <photo url="http://www.eastsiderealty.com/img/296321_int_photo5.jpg"/> <floorplan url="http://www.eastsiderealty.com/fp/296321_1.pdf"/> <floorplan url="http://www.eastsiderealty.com/fp/296321_2.pdf"/> </media> <agents> <agent id="MB12514"> <name>Michelle Brown</name> <photo>http://www.eastsiderealty.com/agent/mb/12514.jpg</photo> <email>mbrown@eastsiderealty.com</email> <lead_email>1231.s1231321@leadgenerator.com</lead_email> <url>http://www.eastsiderealty.com/agent.php?id=12514</url> </agent> <agent id="MW12312"> <name>Michael Williams</name> <photo>http://www.eastsiderealty.com/agent/mw/12312.jpg</photo> <email>mwilliams@eastsiderealty.com</email> <lead_email>1231.s1231321@leadgenerator.com</lead_email> <url>http://www.eastsiderealty.com/agent.php?id=12311</url> </agent> </agents> </property> </properties> </streeteasy>
XML TAG DEFINITIONS
<streeteasy> | required | Encapsulates the file and references the version of the feed format. Currently the version is 1.6 |
<properties> | required | Encloses a list of property tags. |
<property> | required | Each property tag encloses all he information about a single property. This tag can be repeated many times. It has the following required attributes:
|
— | ||
<location> | required | Encloses the information about the geographic location of the property. |
<address> | required | The street address of the property, examples: ‘1 5th Ave’, ‘420 Riverside Boulevard’ |
<apartment> | required for other than single-family homes | Unit number of the apartment, examples: ‘4H’, ‘PH’, ‘4-AB’ |
<city> | required | City name (no abbreviations), examples: Brooklyn, Forest Hills, New York |
<state> | required | Two-character abbreviation for state, example: ‘NY’ |
<zipcode> | required | Five or nine digit US zipcode for the property, examples: ‘10019’, ‘10019-2111’, ‘101284121’ |
<neighborhood> | optional | Neighborhood in which the property is located, examples: ‘Upper East Side’, ‘Inwood’, ‘Brooklyn Heights’. |
— | ||
<details> | required | This tag encloses information about the property. |
<price> | required | This is the price of the property in dollars, we can accept most number formats: ‘241771.00’ or ‘20231’, or ‘$11,001,121’ |
<noFee> | optional | If this is a rental with no broker fee then this tag should be present, no tag content is required. |
<maintenance> | optional | If the property has a monthly maintenance fee or monthly common charges, they should be specified here, the amount should be the monthly amount of the fee not the yearly amount, examples: 2417.00 or 1031, or $1,001 |
<exclusive> | optional | If this is an exclusive listing include this tag. If it is not exclusive then leave this tag out. |
<taxes> | optional | Monthly property taxes, examples: ‘9875.00’ or ‘10328’, or ‘$3,001’ |
<bedrooms> | Required | Number of bedrooms, only whole numbers. If the property is a studio use ‘0’. Examples: ‘0’, ‘1’, ‘4’ |
<bathrooms> | Required | Number of bathrooms. Examples: ‘1’, ‘2’, ‘5’ |
<half_baths> | optional | Number of half bathrooms. Examples: ‘1’, ‘4’ |
<totalrooms> | Required | Total number of rooms in the property |
<squareFeet> | optional | Square footage of the interior living space, excluding outdoor space, examples: ‘657’, ‘1023’ |
<lotArea> | optional | Area of the lot in whole or partial acres, examples: ‘3’, ‘0.85’ |
<lotSize> | optional | Dimensions of the lot as length and width in linear feet, examples: ’20×40′, ’60×90′ |
<availableOn> | optional | If this is a rental property the date the property becomes available for move in. Example 2006-09-25 |
<listedOn> | optional | If this property is already on the market this should be the date it was first listed. Example: 2006-09-21 |
<soldOn> | optional | If this property is sold, this should be the date that it sold on. Example: 2006-05-22 |
<description> | Required | Description of the property. Should not contain any HTML or XML tags. Any special characters should be escaped, Please use CDATA if listing descriptions include line breaks. |
<propertyType> | required | This can be condo, coop, townhouse, condop, rental, house or other |
<mlsId> | optional | The id number in the associated MLS |
<mlsName> | optional | The name of the MLS that this listing is listed in. |
<built> | optional | Date or year the property was originally built |
— | ||
<amenities> | optional | This tag contains other tags specifying the amenities available for this property. These tags contain no data, including a tag indicates that the amenity is available. |
<doorman> | optional | Does the property have a doorman |
<prewar> | optional | Is this a pre-war building, constructed before 1939 |
<gym> | optional | Does the building have a gym |
<pool> | optional | Does the building have a pool |
<elevator> | optional | Does the building have an elevator |
<garage> | optional | Does the building have a garage for residents |
<parking> | optional | Does the building have private parking for residents |
<balcony> | optional | Does the property have a balcony |
<storage> | optional | Does the property have a storage |
<patio> | optional | Does the property have a patio |
<fireplace> | optional | Does the property have a working fireplace |
<washerDryer> | optional | Does the property have a washer and/or dryer |
<dishwasher> | optional | Does the property have a dishwasher |
<furnished> | optional | Is this property furnished |
<pets> | optional | Does this property allow pets |
<other> | optional | A comma delimited string of other amenities |
— | ||
<openHouses> | optional | This tag encloses information about open houses for a listing |
<openHouse> | optional | This tag encloses information about a single open house, there can be several instances of this tag |
<startsAt> | optional | What date and time does the open house start, must match this format 2006-11-20 3:30pm |
<endsAt> | optional | What date and time does the open house end, example: 2006-11-20 4:30pm |
<apptOnly> | optional | Does the Open House is by Appointment Only. |
<apptOnly> | optional | Include if Open House is appointment only |
— | ||
<agents> | optional | This tag encloses information about the agents for a listing If the agent has a unique id in your system there is an optional “id” attribute that can be set to the id of the agent. |
<agent> | optional | This tag encloses information about a single agent, there can be several instances of this tag |
<name> | Required | Full name of the agent for this property, example: George Bloom |
<company> | optional | Name of the company this agent works for, example: Eastside Realty |
<photo> | optional | A url to an image with a photo of the agent, example: http://www.eastsiderealty.com/agent/jdoran/12312.jpg |
<url> | optional | If the agent has a personal page with their bio, listings and other information this is the url of that page, example: http://www.eastsiderealty.com/agent.php?id=12311 |
<email> | Required | Email address of this agent, example: jdoran@eastsiderealty.com |
<lead_email> | optional | If there is a lead generation email that inquiries should be routed through that email address can be placed here. |
<phone_numbers> | optional | Enclosing tag for contact phone numbers for an agent |
<office> | optional | Office phone number, examples: ‘212-651-4811’, ‘7181214633’, ‘646-166-4211 x212’ |
<fax> | optional | Fax number |
<cell> | optional | Cell phone number for this agent’ |
— | ||
<media> | optional | This is an enclosing tag for photos and other media associated with this property |
<photo position=”x”> | optional | Url of an image for this property, example: http://www.eastsiderealty.com/listing/images/121231.jpg Position attribute specifies what order the image should show up in on the listing detail page |
<floorplan> | optional | Url of a floorplan for this property, example: http://www.eastsiderealty.com/listing/fp/121231.jpg |
<video> | optional | Url of a video for this property, example: http://www.eastsiderealty.com/listing/videos/121231.avi |
<otherMedia> | optional | Url for any other media type, example: http://www.eastsiderealty.com/listing/panorama/121231.swf |