API Documentation - Listings

Listings

Requesting Multiple Listings

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.

Example request
https://nestiolistings.com/api/v1/public/listings/?layout=10&min_rent=1500&max_rent=2000&key={API KEY}
Parameters

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.

Response
{
    "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
    }]
}

Requesting Individual Units

GET https://nestiolistings.com/api/v1/public/listings/{id}/

Returns JSON for a specific unit based on the id.

Example request
https://nestiolistings.com/api/v1/public/listings/123/?key={API KEY}
Parameters
Response
{
    "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
}