API Documentation - Listings

Table of Contents

GET /api/v2/listings/all

GET /api/v2/listings/residential/rentals/

GET /api/v2/listings/residential/sales/

GET /api/v2/listings/commercial/rentals/

GET /api/v2/listings/commercial/sales/

These endpoints enable you to query the Nestio Listings Database for the listings that your company has access to. It will return a list of currently available listings that match your search parameters. The /residential/ endpoints will return residential listings only and the /commercial/ endpoints will return commercial listings only. The /rentals/ endpoints will return only rental listings and the /sales/ endpoints will return only sales listings. For an aggregated set of listings (includes both residential and commercial, and both rentals and sales) the /all/ endpoint is provided for convenience.

Parameters

About Multiple Choice Fields

agents, building, management_company, building_ownership, layout, incentives, source, pets, neighborhoods, postal_code, unit_type, unit_type_name

Each of these fields may be used to filter for listings that match one or more of the values submitted in the query, in other words, the query combines with OR logic. in order to include multiple values in your query for a multiple choice field simply include the querystring parameter multiple times in the URL of your API request. for example, request below will include listings assigned to agent 42 or agent 43 or agent 44.

https://nestiolistings.com/api/v2/listings/residential/rentals/?key=<your_key>&agents=42&agents=43&agents=44


Filter Paramters

Sort Parameters

Other Parameters

Example Request and Response

Example request made via client side JavaScript using jQuery:

var apiData = $.ajax("https://nestiolistings.com/api/v2/listings/residential/rentals/?key=<your_key>&has_photos=1")

Example response body:

{
total_items: 500,
items: [
    {
    max_lease_term: 24,
    exclusive: null,
    min_lease_term: 12,
    bathrooms: 2,
    square_footage: null,
    updated_at: "2015-07-18T11:12:32.786308",
    property_type: "Residential",
    id: 350889,
    occupancy_status: null,
    renter_fee: null,
    layout: "2 Bedroom",
    floor: null,
    date_available: "2015-09-01",
    last_listed_at: "2015-07-18T11:12:32.786508",
    source: "Blast",
    amenities: [
        "Hardwood Floors",
        "Stainless Steel Appliances",
        "Windowed Kitchen",
        "Pass-Through Kitchen",
        "Walk-In Closet",
        "Marble",
        "Desirable Layout"
    ],
    pets: "Pets Allowed",
    access_info: "To schedule a viewing, contact Example Broker. example@fakebrokerage.com 555-555-5555",
    status: "Available",
    description: "",
    price: "7200.00",
    bedrooms: 2,
    incentives: null,
    key_in_office: null,
    listing_company: {
        phone_number: "(555) 555-5555",
        email: "",
        website: "",
        name: "Example Management Company",
        address: "123 Some St, New York, NY 10010",
        logo: null,
        company_id: 1289,
        fax_number: ""
    },
    photos: [
        {
        original: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?s=a51703d90404d302f030b5b79c1b324a",
        large: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
        thumbnail: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
        sort_order: 0,
        small: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
        xlarge: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a",
        media_type: "Photo",
        id: 2677180
        },
        {
        original: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?s=a51703d90404d302f030b5b79c1b324a",
        large: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
        thumbnail: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
        sort_order: 1,
        small: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
        xlarge: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a",
        media_type: "Photo",
        id: 2677181
        },
        {
        original: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?s=a51703d90404d302f030b5b79c1b324a",
        large: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
        thumbnail: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
        sort_order: 2,
        small: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
        xlarge: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a",
        media_type: "Photo",
        id: 2677182
        },
        {
        original: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?s=a51703d90404d302f030b5b79c1b324a",
        large: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
        thumbnail: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
        sort_order: 3,
        small: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
        xlarge: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a",
        media_type: "Photo",
        id: 2677183
        }
    ],
    listing_type: "For Rent",
    building: {
    cross_streets: [
        "Columbus Ave / W 59th St"
    ],
    neighborhood: {
    name: "Midtown West",
    area: "Midtown Manhattan"
    },
    id: 103019,
    city: "Manhattan",
    name: "",
    building_ownership: null,
    postal_code: "10019",
    state: "NY",
    amenities: [ ],
    location: {
    latitude: 40.7691689,
    longitude: -73.9850159
    },
    building_description: "",
    street_address: "1 Columbus Pl"
    },
    first_showing_date: null,
    unit_number: "N-46D",
    open_houses: [ ],
    mls_policies: {
        vow_opt_out: false,
        idx_opt_out: false,
        allow_comments: false,
        allow_automated_valuations: false,
        cobroke_agreement: "REBNY Universal Co-broke"
    },
    contacts: [ ],
    street_address: "1 Columbus Pl"
    }
],
total_pages: 500,
page: 1
}

Glossary of Listing Object Fields

Fields common to all listings
Additional fields for rental listings
Additional fields for sale listings
Additional fields for commercial listings

Single Listing

GET /api/v2/listings/<listing_id>/

This endpoint returns the data for a single currently available open listing.

Additional Parameters

These parameters can be passes as query string parameters to customize the response.

Example request made via client side JavaScript using jQuery:

var apiData = $.ajax("https://nestiolistings.com/api/v2/listings/350889/?key=<your_key>")

Example Response Body

{
    max_lease_term: 24,
    exclusive: null,
    min_lease_term: 12,
    bathrooms: 2,
    square_footage: null,
    updated_at: "2015-07-18T11:12:32.786308",
    property_type: "Residential",
    id: 350889,
    occupancy_status: null,
    renter_fee: null,
    layout: "2 Bedroom",
    floor: null,
    date_available: "2015-09-01",
    last_listed_at: "2015-07-18T11:12:32.786508",
    source: "Blast",
    amenities: [
        "Hardwood Floors",
        "Stainless Steel Appliances",
        "Windowed Kitchen",
        "Pass-Through Kitchen",
        "Walk-In Closet",
        "Marble",
        "Desirable Layout"
    ],
    pets: "Pets Allowed",
    access_info: "To schedule a viewing, contact Example Broker. example@fakebrokerage.com 555-555-5555",
    status: "Available",
    description: "",
    fee_structure: "CYOF",
    price: "7200.00",
    bedrooms: 2,
    incentives: null,
    key_in_office: null,
    listing_company: {
        phone_number: "(555) 555-5555",
        email: "",
        website: "",
        name: "Example Management Company",
        address: "123 Some St, New York, NY 10010",
        logo: null,
        company_id: 1289,
        fax_number: ""
    },
    photos: [
        {
        original: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?s=a51703d90404d302f030b5b79c1b324a",
        large: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
        thumbnail: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
        sort_order: 0,
        small: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
        xlarge: "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a",
        media_type: "Photo",
        id: 2677180
        },
        {
        original: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?s=a51703d90404d302f030b5b79c1b324a",
        large: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
        thumbnail: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
        sort_order: 1,
        small: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
        xlarge: "https://assets-img.nestiostatic.com/unit_photos/originals/91708378e4274873fa3277ed0b5df868.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a",
        media_type: "Photo",
        id: 2677181
        },
        {
        original: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?s=a51703d90404d302f030b5b79c1b324a",
        large: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
        thumbnail: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
        sort_order: 2,
        small: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
        xlarge: "https://assets-img.nestiostatic.com/unit_photos/originals/d02110ba661debdba5ab3ac1beccecf6.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a",
        media_type: "Photo",
        id: 2677182
        },
        {
        original: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?s=a51703d90404d302f030b5b79c1b324a",
        large: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
        thumbnail: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
        sort_order: 3,
        small: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
        xlarge: "https://assets-img.nestiostatic.com/unit_photos/originals/866d8628376baefe54fc3013f65762d1.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a",
        media_type: "Photo",
        id: 2677183
        }
    ],
    listing_type: "For Rent",
    building: {
    cross_streets: [
        "Columbus Ave / W 59th St"
    ],
    neighborhood: {
    name: "Midtown West",
    area: "Midtown Manhattan"
    },
    id: 103019,
    city: "Manhattan",
    name: "",
    building_ownership: null,
    postal_code: "10019",
    state: "NY",
    amenities: [ ],
    location: {
    latitude: 40.7691689,
    longitude: -73.9850159
    },
    building_description: "",
    building_age: "New Development",
    building_type: "Loft",
    year_built: 2011,
    total_units: 50,
    floors: 10.0,
    tax_lot: "11",
    tax_block: "12",
    street_address: "1 Columbus Pl"
    },
    first_showing_date: null,
    unit_number: "N-46D",
    open_houses: [ ],
    mls_policies: {
        vow_opt_out: false,
        idx_opt_out: false,
        allow_comments: false,
        allow_automated_valuations: false,
        cobroke_agreement: "REBNY Universal Co-broke"
    },
    contacts: [ ],
    street_address: "1 Columbus Pl"
}

glossary of listing object fields

Listings Sync

About Multiple Choice Fields

'listing_type' and 'property_type'

these fields can accept multiple values. if omitted the default values will be used (listing_type=rentals, property_type=residential). if you would like to, for example mix together rentals and sales in the same query result you can include the listing_type parameter multiple times. example:

https://nestiolistings.com/api/v2/sync/listings/?listing_type=rentals&listing_type=sales

GET /api/v2/sync/listings/

This end-point allows you to sync listings in bulk from Nestio’s database into your own. The data will be returned in paginated form with 50 listings per page, and can be filtered using the following options as query string parameters.

Accepted Filter Parameters & Values
Authentication

The Listings Sync endpoint is only available using Basic Authentication. Before you use the listings sync endpoint, please confirm with your Nestio representative that your Nestio plan includes sync access, and it is enabled for your API key.

Pagination

The sync API uses pointer-based pagination. Each page of API results provides a pointer to the next available page. To get the pointer to the next page, look for the ['pointer']['next_id'] field in the response:

{
    "items": [ listings... ],
    "pointer": {
        "next_id": 234567
    }
}

And then to retrieve the next page pass that value as the max_id parameter:

https://nestiolistings.com/api/v2/sync/listings/?max_id=234567

If you are using any filter parameters, be sure to pass those along with the max_id, such as

https://nestiolistings.com/api/v2/sync/listings/?updated_since=2015-05-19T12:47:00&max_id=234567

Glossary of Listings Sync Object Fields and Accepted Values