Contents

• Overview
• XML Feed Format
• Sample Feed
• XML Tag Definitions
• Fee Types

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 '&gt;' and '>' to '&lt;'
• 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|unavailable|sold|rented"
      id="unique id" url="external url for the property">
      <location>
        <address/>
        <apartment/>
        <city/>
        <state/>
        <zipcode/>
        <neighborhood/>
      </location>

      <details>
        <price/>
        <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/>
        <saletype>Sponsor Unit|Resale|Foreclosure|Auction Sale|Restricted Sale|Short Sale</saletype>
        <amenities>
          <!-- include all that apply -->
          <balcony/>
          <central_ac/>
          <city_view/>
          <courtyard/>
          <decorative_fireplace/>
          <dishwasher/>
          <doorman/>
          <elevator/>
          <fireplace/>
          <furnished/>
          <garage/>
          <garden/>
          <garden_view/>
          <gas_fireplace/>
          <gym/>
          <hardwood_floors/>
          <loft/>
          <park_view/>
          <parking/>
          <patio/> <!-- Outdoor space -->
          <pets/>
          <pool/>
          <private_roof_deck/>
          <roof_rights/>
          <skyline_view/>
          <storage/>
          <terrace/>
          <washer_dryer/>
          <waterview/>
          <wood_fireplace/>
          <other/> <!-- A comma delimited string of other amenities -->
        </amenities>
        <leaseConcession> <!-- rental only -->
          <concessionLeaseTerm/>
          <concessionMonthsFree/>
        </leaseConcession>
      </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="">

        <_3DTour url=""/>
      </media>

      <fees> <!-- rental only -->
        <fee>
          <feeType>application_fee|security_deposit|...</feeType> <!-- please refer to the Fee Types section for the list of valid fee types -->
          <occurrenceType>during_lease_term|move_in|move_out|pre_application|application_submission|annually|monthly</occurrenceType>
          <requirementType>required|optional|contingent</requirementType>
          <calculationType>flat_fee|variable_usage_based|per_item|range</calculationType>
          <refundAvailability>refundable|non_refundable</refundAvailability>
          <amount/>
          <maxAmount/><!-- if calculationType is range, this is required -->
        </fee>
      </fees>
    </property>
  </properties>
</streeteasy>

Sample Feed

Sale 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>
        <saletype>Sponsor Unit</saletype>
        <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"/>
        <_3DTour url="https://www.zillow.com/view-3d-home/7a885be6-cb0d-428d-8e8c-3e8323dd0aee"/>
      </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>

Rental Sample Feed

<?xml version="1.0" encoding="UTF-8"?>
<streeteasy version="1.6">
  <properties>
    <property status="active" type="rental" id="108383" url="https://www.rentalnewyork.com/listings/108383">
      <location>
        <address>511 1st Ave</address>
        <apartment>71E</apartment>
        <city>New York</city>
        <state>NY</state>
        <zipcode>10003</zipcode>
        <neighborhood>East Village</neighborhood>
      </location>
      <details>
        <price>2350.00</price>
        <exclusive/>
        <bedrooms>1</bedrooms>
        <bathrooms>1</bathrooms>
        <totalrooms>3</totalrooms>
        <availableOn>2018-04-01</availableOn>
        <description>
          <![CDATA[
            51 First Avenue
            <br /> SPACIOUS 1 BEDROOM APARTMENT - HUGE LAYOUT - PRIME EAST VILLAGE BLOCK!
            <br /> Apartment:
            <br /> -King Sized Bedroom with East Facing Windows
            <br /> -Ample Room for Furniture in the Bedroom
            <br /> -Living and Dining Room Area
            <br /> -Large Kitchen Area
            <br /> -Plenty of Cabinet and Counter-top Space
            <br /> -Tiled Bathroom with Bathtub
            <br /> -Hardwood Floors
            <br /> Building:
            <br /> -Local Super
            <br /> -Responsive Management
            <br /> -Well Maintained Building
            <br /> -Intercom System
            <br /> **Please Note – advertised pictures are stock photos that represent the layout and quality of renovations in the apartment.**
          ]]>
        </description>
        <propertyType>rental</propertyType>
        <built>1900</built>
        <amenities>
          <other>hardwood floors, microwave, renovated</other>
        </amenities>
        <leaseConcession>
          <concessionLeaseTerm>12</concessionLeaseTerm>
          <concessionMonthsFree>2</concessionMonthsFree>
        </leaseConcession>
      </details>
      <openHouses>
        <openHouse>
          <startsAt>2018-03-14 5:00PM</startsAt>
          <endsAt>2018-03-14 7:00PM</endsAt>
          <apptOnly/>
        </openHouse>
      </openHouses>
      <agents>
        <agent id="05c753ff-5598-4ae4-8f31-f11916d7464f">
          <name>John Smith</name>
          <company>Rental New York</company>
          <email>john@rentalnewyork.com</email>
          <phone_numbers>
            <main>234-567-8910</main>
          </phone_numbers>
        </agent>
      </agents>
      <media>
        <_3DTour url="https://www.zillow.com/view-3d-home/7a885be6-cb0d-428d-8e8c-3e8323dd0aee"/>
        <floorplan url="https://ny-production.imgix.net/00000000-0000-0000-0000-%2500000000000g?ixlib=rb-1.1.0"/>
        <photo url="https://ny-production.imgix.net/40242584-1520-416d-b716-508118bc67d0?ixlib=rb-1.1.0"/>
        <photo url="https://ny-production.imgix.net/a2ff4c5d-6983-49f1-a7cf-a60cffe43338?ixlib=rb-1.1.0"/>
        <photo url="https://ny-production.imgix.net/5a0d3c46-511a-4390-baad-743411820d56?ixlib=rb-1.1.0"/>
        <photo url="https://ny-production.imgix.net/1b7e43c3-c273-400c-94b9-2ea5bfb2df5c?ixlib=rb-1.1.0"/>
        <photo url="https://ny-production.imgix.net/1341f52b-ea39-4759-8181-a5c46241a499?ixlib=rb-1.1.0"/>
        <otherMedia url="https://youtu.be/EIAUU" description="Virtual Tour"/>
        <otherMedia url="https://youtu.be/NSwlA" description="Virtual Tour"/>
      </media>
      <fees>
        <fee>
          <feeType>security_deposit</feeType>
          <occurrenceType>move_in</occurrenceType>
          <requirementType>required</requirementType>
          <calculationType>flat_fee</calculationType>
          <refundAvailability>refundable</refundAvailability>
          <amount>2000</amount>
        </fee>
        <fee>
          <feeType>application_fee</feeType>
          <occurrenceType>application_submission</occurrenceType>
          <requirementType>required</requirementType>
          <calculationType>per_item</calculationType>
          <refundAvailability>non_refundable</refundAvailability>
          <amount>20.00</amount>
        </fee>
        <fee>
          <feeType>community_amenity_fee</feeType>
          <occurrenceType>monthly</occurrenceType>
          <requirementType>required</requirementType>
          <calculationType>flat_fee</calculationType>
          <refundAvailability>non_refundable</refundAvailability>
          <amount>75.00</amount>
        </fee>
        <fee>
          <feeType>pet_deposit</feeType>
          <occurrenceType>move_in</occurrenceType>
          <requirementType>optional</requirementType>
          <calculationType>flat_fee</calculationType>
          <refundAvailability>refundable</refundAvailability>
          <amount>150.00</amount>
        </fee>
        <fee>
          <feeType>storage_fee</feeType>
          <occurrenceType>monthly</occurrenceType>
          <requirementType>optional</requirementType>
          <calculationType>range</calculationType>
          <refundAvailability>non_refundable</refundAvailability>
          <amount>50.00</amount>
          <maxAmount>100.00</maxAmount>
        </fee>
        <fee>
          <feeType>key_replacement</feeType>
          <requirementType>contingent</requirementType>
          <calculationType>flat_fee</calculationType>
          <refundAvailability>non_refundable</refundAvailability>
          <amount>50.00</amount>
        </fee>
      </fees>
    </property>
  </properties>
</streeteasy>

XML Tag Definitions

Fee Types