Printed from StreetEasy.com at 03:44 AM, Apr 23 2014
http://streeteasy.com/api/info

StreetEasy APIs (Beta)

To get an API key, you need to signup for a FREE StreetEasy account

General Notes

All calls require a key parameter with your API key. Calls might return with status 403 (Forbidden) if you exceed 100 calls per hour. Contact us if you require a larger rate allowance.

Many of our APIs accept sets of criteria. For more information, see the Sale Criteria and Rental Criteria references.

Aggregated Listing Data API

Provides aggregated calculations for a given set of criteria

End points
For Sale listings:
http://streeteasy.com/nyc/api/sales/data
For Rental listings:
http://streeteasy.com/nyc/api/rentals/data
Method
GET
Format
JSON or XML (use format=json or format=xml parameters)
Parameters
criteria: a pipe-separated (|) set of criteria. See the Sale Criteria and Rental Criteria references.
Example
http://streeteasy.com/nyc/api/sales/data?criteria=area:soho-manhattan|beds:3&key=XXX&format=json
Results in:
      {
        criteria_description: Sale listings in Soho with 3 bedrooms
        criteria: area:soho-manhattan|beds:3
        search_url: http://streeteasy.com/nyc/sales/soho-manhattan/beds:3
        updated_at: 2010-11-06T07:35:26-04:00
        listing_count: 51
        average_price: 5352745
        stddev_price: 3863310
        median_price: 4395000
        percentile_10_price: 2300000
        percentile_90_price: 8450000
        sqft_count: 47
        average_sqft: 3232
        stddev_sqft: 1339.93
        median_sqft: 3021
        average_ppsf: 1746
        median_ppsf: 1617
        wom_count: 48
        average_wom: 29.4792
        stddev_wom: 30.2852
        median_wom: 22
        decrease_count: 17
        average_decrease: 800.824
        stddev_decrease: 524.502
        increase_count: 1
        average_increase: 434
        stddev_increase: 0
      }
      

Most of the values are self-explanatory. sqft means "square foot", wom is "weeks on market", ppsf is "price per square foot" and stdev is "standard deviation".

listing_count represents how many listings matched the given criteria, while sqft_count reflects how many included square footage information, wom_count how many had "weeks on market" data, and so on.

Area/Neighborhood API

Area Search

Search area/neighborhood by name.
End points
http://streeteasy.com/nyc/api/areas/search
Method
GET
Format
JSON or XML (use format=json or format=xml parameters)
Parameters
q: text to query
Example
http://streeteasy.com/nyc/api/areas/search?q=soho&key=XXX&format=json
Results in:
        {
          areas: [
            {
              city: New York
              level: 3
              id: 107
              parent_id: 102
              path: soho-manhattan
              state: NY
            }
            {
              city: New York
              level: 2
              id: 102
              parent_id: 100
              path: downtown-manhattan
              state: NY
            }
          ]
        }
        

Results are returned in order of specificity.

Either id or path can be used to identify areas in other API calls.

Area Information

End points
For information about a single area:
http://streeteasy.com/nyc/api/areas/info
For information about an area and all its descendants:
http://streeteasy.com/nyc/api/areas/deep_info/{area}
Method
GET
Format
JSON or XML (use format=json or format=xml parameters)
Parameters
{id}: a numeric or string area identifier.
Example
http://streeteasy.com/nyc/api/areas/info?id=soho-manhattan&key=XXX&format=json
Results in:
            {
              city: New York
              level: 3
              id: 107
              parent_id: 102
              path: soho-manhattan
              state: NY
            }
            

Area GeoJSON

End points
http://streeteasy.com/nyc/api/areas/geojson/{id}
http://streeteasy.com/nyc/api/areas/geojson?areas={id}
Method
GET
Format
GeoJSON - a "FeatureCollection" including a "Feature" for each selected area.
Parameters
{id}: a numeric or string area identifier. Use comma-separated values for multiple areas.
Example
http://streeteasy.com/nyc/api/areas/geojson?areas=soho-manhattan,tribeca-manhattan&key=XXX
Results in:
            {
              type: "FeatureCollection",
              features: [
                {
                  type: "Feature",
                  geometry: {
                    type: "Polygon",
                    coordinates: [[[-74.01070,40.72911], ... ]]
                  },
                  properties: {
                    id: 107,
                    name: "Soho",
                    geo_name: "Soho",
                    city: "New York",
                    state: "NY",
                    level: 3,
                    position: 6,
                    path: "soho-manhattan",
                    parent_path: "downtown-manhattan",
                    parent_name: "All Downtown",
                    parent_id: 102
                  }
                },
                {
                  type: "Feature",
                  geometry: {
                    type: "Polygon",
                    coordinates: [[[-74.01527,40.72629], ... ]]
                  },
                  properties: {
                    id: 105,
                    name: "Tribeca",
                    geo_name: "Tribeca",
                    city: "New York",
                    state: "NY",
                    level: 3,
                    position: 5,
                    path: "tribeca-manhattan",
                    parent_path: "downtown-manhattan",
                    parent_name: "All Downtown",
                    parent_id: 102
                  }
                }
              ]
            }
            
(See in map)

Area Options

End points
http://streeteasy.com/nyc/api/areas/options
Method
GET
Format
JSON or XML (use format=json or format=xml parameters)
Parameters
id: a numeric or string area identifier. Can be omitted.
Example
http://streeteasy.com/nyc/api/areas/info?id=downtown-manhattan&key=XXX&format=json
Results in:
            {
              hashes: [
                {
                  value: 139
                  text: All Upper East Side
                }
                {
                  value: 143
                  text:   Carnegie Hill
                }
                {
                  value: 141
                  text:   Lenox Hill
                }
                {
                  value: 140
                  text:   Upper East Side
                }
                {
                  value: 142
                  text:   Yorkville
                }
              ]
            }
            

Find Area By Address

End points
http://streeteasy.com/nyc/api/areas/for_address
Method
GET
Format
JSON or XML (use format=json or format=xml parameters)
Parameters
address: street address. Might include city name after a comma. city: city name, to narrow down the search zip: zip code, to narrow down the search
Example
http://streeteasy.com/nyc/api/areas/for_address?address=540+W+21+St&city=New+York&key=XXX&format=json
Results in:
            {
              city: New York
              name: Chelsea
              level: 3
              id: 115
              parent_id: 102
              path: chelsea-manhattan
              state: NY
            }
            

Find Area By Location

End points
http://streeteasy.com/nyc/api/areas/by_location
Method
GET
Format
JSON or XML (use format=json or format=xml parameters)
Parameters
lat: Latitude lon: Longitude
Example
http://streeteasy.com/nyc/api/areas/for_location?lon=-74.0076&lat=40.7186&key=XXX&format=json
Results in:
            {
              city: New York
              name: Tribeca
              level: 3
              id: 105
              parent_id: 102
              path: tribeca-manhattan
              state: NY
            }