GET https://nestiolistings.com/api/v1/public/listings/
Allows you to search listings. Results are paginated in groups of 50, using the page parameter will allow to specify the page you’d like.
https://nestiolistings.com/api/v1/public/listings/?layout=10&min_rent=1500&max_rent=2000&key={API KEY}
listing_type - Filter listings by either sales or rentals:
layout -
Accepts multiple parameters. Valid Options:
bathrooms - The minimum number of bathrooms. Valid options:
min_rent - Minimum rent, decimal value.max_rent - Maximum rent, decimal value.cats_allowed - Boolean, accepts true or falsedogs_allowed - Boolean, accepts true or falseelevator - Boolean, accepts true or falsedoorman - Boolean, accepts true or falsedate_available_after - Units available after given date, format: YYYY-MM-DD.date_available_before - Units available after given date, format: YYYY-MM-DD.laundry_in_building - This will return all units that have either laundry in the building or in the unit.laundry_in_unit - This will only return units with laundry in the unithas_photos - Boolean, accepts true or falsefeatured - Only return featured units. Boolean, accepts true or falseneighborhoods - Accepts a neighborhood ID to limit units. Multiple parameters are accepted. (Parameter can be shortened to n for long requests). Neighborhood ID’s are available from the /neighborhoods/ end point.geometry - Accepts a set of (long, lat) coordinates that form a polygon. Two different representations of the polgyon (examples below). Note that a polygon must consist of a set of points such that the points form a closed ring with the start point and end point being the same:
OGC style - example: “POLYGON((0.0 0.0, 0.0 1.0, 1.0 1.0, 1.0 0.0, 0.0 0.0))”Simple style - example: “0.0,0.0 |
0.0,1.0 | 1.0,1.0 | 1.0,0.0 | 0.0,0.0” |
agents - Accepts a list of one or more agent ID numbers. Filtering by agents will return only listings to which the selected agents are assigned to.sort - Valid options:
layoutrentdate_availableupdated - The last time a key property, such as rent or status was changed on the unit.status_updated - The last time the unit’s status was changed (i.e. when the unit went from rented to available).sort_dir - Sort direction, either asc or descper_page - The number of results returned on each page, maximum value is 50.To send multiple options to the parameters that accept them, just list out multiple parameters with each option in the query string i.e. layout=10&layout=20&neighborhoods=23&neighborhoods=56.
{
"total_items" : 114,
"total_pages" : 3,
"page" : 1,
"items" : [{
"max_lease_term" : null,
"status" : "Available",
"min_lease_term" : null,
"renter_fee" : null,
"bathrooms" : 1.0,
"building" : {
"city" : "Manhattan",
"state" : "NY",
"zipcode" : "10024",
"neighborhood" : {
"name" : "Upper West Side",
"area" : "Uptown Manhattan"
},
"name" : null,
"amenities" : [],
"id" : null,
"street_address" : "West 81st Street",
"location" : {
"latitude" : 40.783360999999999,
"longitude" : -73.975147499999977
}
},
"floor" : null,
"date_available" : "2014-05-21",
"unit_amenities" : ["Hardwood", "Light"],
"unit_description" : "This unit is so great.",
"pets": "Pets Allowed",
"changed_at" : "2014-07-30T10:03:32+00:00",
"photos" : [{
"large" : "https://nestiolistings-assets.s3.amazonaws.com/unit_photos/large/6f898e0be6d013e4acfc17637faed6ba.jpg",
"is_floorplan" : false,
"local_file_name" : "6f898e0be6d013e4acfc17637faed6ba.jpg",
"small" : "https://nestiolistings-assets.s3.amazonaws.com/unit_photos/small/6f898e0be6d013e4acfc17637faed6ba.jpg",
"media_type" : 10,
"original" : "https://nestiolistings-assets.s3.amazonaws.com/unit_photos/originals/6f898e0be6d013e4acfc17637faed6ba.jpg",
"id" : 138596,
"thumbnail" : "https://nestiolistings-assets.s3.amazonaws.com/unit_photos/thumbnails/6f898e0be6d013e4acfc17637faed6ba.jpg"
}],
"square_footage" : null,
"rent" : 1895.00,
"contacts": [{
"phone_number" : "123-456-7890",
"mobile_phone_number" : "",
"name" : "John Broker",
"email" : "broker1@brokerage.com"
}],
"layout" : "Studio",
"id" : 40029
}]
}
GET https://nestiolistings.com/api/v1/public/listings/{id}/
Returns JSON for a specific unit based on the id.
https://nestiolistings.com/api/v1/public/listings/123/?key={API KEY}
similar_units - Also include similar units. Boolean, accepts true or false. Note, these will be returned as a list of unit objects similar to the primary unit object{
"max_lease_term" : null,
"status" : "Available",
"min_lease_term" : null,
"renter_fee" : null,
"bathrooms" : 1.0,
"building" : {
"city" : "Manhattan",
"state" : "NY",
"neighborhood" : {
"name" : "Upper West Side",
"area" : "Uptown Manhattan"
},
"name" : null,
"amenities" : [],
"id" : null,
"street_address" : "West 81st Street",
"location" : {
"latitude" : 40.783360999999999,
"longitude" : -73.975147499999977
}
},
"floor" : null,
"date_available" : "2014-05-21",
"unit_amenities" : ["Hardwood", "Light"],
"unit_description" : "",
"open_houses": [
{
"date": "2015-01-10",
"start_time": "09:30:00",
"end_time": "11:00:00"
}
],
"changed_at" : "2014-07-30T10:03:32+00:00",
"photos" : [{
"large" : "https://nestiolistings-assets.s3.amazonaws.com/unit_photos/large/6f898e0be6d013e4acfc17637faed6ba.jpg",
"is_floorplan" : false,
"local_file_name" : "6f898e0be6d013e4acfc17637faed6ba.jpg",
"small" : "https://nestiolistings-assets.s3.amazonaws.com/unit_photos/small/6f898e0be6d013e4acfc17637faed6ba.jpg",
"media_type" : 10,
"original" : "https://nestiolistings-assets.s3.amazonaws.com/unit_photos/originals/6f898e0be6d013e4acfc17637faed6ba.jpg",
"id" : 138596,
"thumbnail" : "https://nestiolistings-assets.s3.amazonaws.com/unit_photos/thumbnails/6f898e0be6d013e4acfc17637faed6ba.jpg"
}],
"square_footage" : null,
"rent" : 1895.00,
"contacts": [{
"agent_id": 42,
"phone_number" : "123-456-7890",
"mobile_phone_number" : "",
"name" : "John Broker",
"email" : "broker1@brokerage.com"
}],
"layout" : "Studio",
"id" : 40029
}