API Documentation

Listings Search

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 Funnel 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

agents
- A list of one or more agent ID numbers. Returns only listings to which the selected agents are assigned to.
geometry
- 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
listing_type
- rentals
- sales
property_type
- residential
- commercial
commercial_use
- office
- retail
- industrial
- storage
building
- A list of one or more building ID numbers. Filtering by buildings will return only listings which are in the selected buildings.
building_name_address
- An address or building name string. Will attempt to find listings based on best match of the address or building name entered. This is an algorithmic matching method and might produce imprecise or unexpected results on occasion.
building_ownership
- condo
- coop
- condop
- singlefamily
- multifamily
company
- A list of one or more company ID numbers. Returns only listings which were provided by the selected companies. NOTE: brokerage exclusive listings often list the brokerage as the management company.
exclusive true or false.
min_price
- A decimal number e.g. 1400.50
max_price
- A decimal number e.g. 1500.75
elevator
- true or false.
doorman
- full-time
- part-time
- no-doorman
pets
- cats
- small-dogs
- large-dogs
layout
- loft
- studio
- 1br
- 2br
- 3br
- 4+br
bathrooms
- 1
- 1.5
- 2
- 2.5
- 3
- 3.5
- 4+
neighborhoods
- A list of neighborhood ID numbers. Returns only listings in buildings located in one of the selected neighborhoods.
postal_code
- any 5 digit postal code (aka zipcode) for a U.S. address. i.e. “12345” but not “12345-6789”
date_available_before
- A date formated as ‘YYYY-MM-DD’
date_available_after
- A date formatted as ‘YYYY-MM-DD’
has_photos
- true or false
incentives
- owner-paid
- months-free
open_house_begin
- A date formatted as ‘YYYY-MM-DD’
open_house_end
- A date formatted as ‘YYYY-MM-DD’
featured
- true or false
source
- realtime
- rls
- my-company
city
- A string name of the city or borough
is_renovated
- true or false
dishwasher
- true or false
microwave
- true or false
exposed_brick
- true or false
hardwood_floors
- true or false
virtual_doorman
- true or false
storage
- true or false
short_term
- limits listings to those with a minimum lease term under twelve months
- true or false
live_in_super
- true or false
last_listed_at_before
- A date formatted as ‘YYYY-MM-DD’
last_listed_at_after
- A date formatted as ‘YYYY-MM-DD’
parking
- any
- off-street
- garage
include_private
- By default the API will not include any listings marked as private in Funnel. If you pass this parameter with a value of true, the API will include listings marked as private. This is helpful when displaying listings in an internal system. Listings marked private are typically intended not to be marketted and should not be displayed publically.
- Default value is false
- true or false
unit_type
- A list of one or more unit type ID numbers. Returns only listings associated with specified unit types.
unit_type_name
- A list of one or more unit type names(string value). Returns only listings associated with specified unit type names.
floorplan
- A list of one or more floorplan ID numbers.
property
- A list of one of more Funnel Community IDs.

Sort Parameters

sort
- Valid options:
  - building
  - layout
  - price
  - date_available
  - updated - 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).
  - neighborhood
  - prioritize-company - Assigns listings a value based on their management company, pushing a user’s company listings to the top. Exclusive listings are prioritized over open listings.
  - next-openhouse - Sorts by upcoming open house date.
sort_dir
- Sort direction, either asc or desc.
- The default sort_dir is asc except for sort options updated and status_updated.

Other Parameters

display_agent
- Accepts and ID of an agent. If the agent has made any edits to listings, such as adding their own photos or description, these will be included with the returned listings. Addtionally, that agent’s contact information will be returned as the contact information for the listings.

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,
    featured: false,
    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: ""
    },
    primary_video_url: "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    secondary_video_url: "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    virtual_tour_url: "https://virtualtours.com/1234",
    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

access_info - text, describing how to access the listing for a showing
amenities - list of amenities and unit features
bathrooms - number of bathrooms in the unit. example: a unit with 1 full bathroom and 1 half bathroom will have ‘1.5’ as the value of bathrooms.
bedrooms - integer number of bedrooms in the unit. studio and loft units will have ‘0’ as the value of bedrooms.
building
- id - Funnel database id of the building
- name - the nickname of the building if it has one, or null otherwise
- street_address - the street address of the building, modified by address display preferences. see here for more info on display preferences
- neighborhood
  - area - some locales have groupings of neighborhoods into larger areas, for example “Midtown Manhattan”
  - name - the colloquial name of the neighborhood. example: “Flatiron District”
- city - the name of the city or borough
- state - 2 letter postal code abbreviation. example: “NY” or “NJ”
- postal_code - the USPS postal code of the building
- location
  - latitude
  - longitude
- amenities - list of amenities and building features
- building_description - text description of the building
- building_age - string. “Pre-War”, “Post-War”, or “New Development”
- year_built - integer. example: 2009
- total_units - integer. total units in the building.
- floors - float. number of floors in the building. example: 15.0
- tax_lot - string. for the city’s record keeping system for parcels of land.
- tax_block - string. for the city’s record keeping system for parcels of land.
- building_type - string. example: “High-Rise” or “Townhouse”
- building_ownership - the ownership class of the building. example: “condo” or “co-op”
- cross_streets - cross streets of the building’s address, if we have them, otherwise null. this field will be modified by address display preferences see here for more info on display preferences
- source_id - if the building data originated from a source external to Funnel, we will include the id number assigned by that source to the building here
updated_at - timestamp of the most recent change to the listing
contacts
- agent_id - Funnel database id of the agent
- name
- email
- phone_number
- mobile_phone_number
- title
- headshot
  - original - url of the image with the original size it was uploaded as
  - thumbnail - url of the image resized to be suitable for use as a small thumbnail
commission_structure - if we have information about the unit’s commission structure it will appear here. Note: this data will only appear if your API key is configured to provide broker info.
date_available - timestamp when the unit is available for move-in
description - text description of the unit itself
exclusive - true if the unit is exclusive to the listing brokerage
exposure - if we have data about the unit’s facing it will appear here with one of the following possible values: North, East, South, West
fee_structure - either “CYOF” (Collect Your Own Fee) or “Co-Broke”
first_showing_date
floor - the floor of the building the unit is located on
furnished_price - if the unit is provided furnished it might have a different price than the normal listed price.
furnished_type - if the unit is furnished it might have one of the following types of furnishing: Unfurnished, Furnished, Optional.
key_in_office - true if the listing brokerage possesses the key
id - Funnel database id of the unit
last_listed_at - timestamp of the most recent previous listing of the unit
layout - a more detailed description of the layout of the unit. for example, a unit with 2 bedrooms and a home office will have bedrooms “2”, but layout will have the more detailed description “2 Bedroom /w HO”.
listing_type - sale or rental
listing_company
- phone_number
- email
- website
- name
- address
- logo
- company_id
- fax_number
mls_policies - this field lists policies specific to the MLS source the listing is from
- vow_opt_out - if true, this listing may not be displayed on a RLS VOW website
- idx_opt_out - if true, this listing may not be displayed on a RLS IDX website
- allow_comments - if true, the MLS source allows user comments to be left on the listing
- allow_automated_valuations - if true, the MLS source allows automated property valuation services to leave estimates on the listing
- cobroke_agreement - this will show text describing the type of cobroke agreement the listing is permitted to be marketed with
occupancy_status - true if the unit has a current tenant
open_houses
- start_time
- end_time
- date
pets - description of what kinds of pets the building’s management company allows
primary_video_url - URL of the primary video associated with the listing
secondary_video_url - URL of the secondary video associated with the listing
virtual_tour_url - URL of the virtual tour associated with the listing
photos - Please note that there are query parameters after the file extension on image urls. You don’t need to concern yourself with these - the important information is provided in the JSON keys.
- id - Funnel database id of the photo
- original - url of the image with the original size it was uploaded as
- thumbnail - url of the image resized to be suitable for use as a small thumbnail (100px by 70px, cropped)
- small - url of the image resized to be larger than a thumbnail but smaller than the original (240px by 180px, cropped)
- large - url of the image resized to be larger than thumbnail and small sizes (720px by 540px, cropped)
- xlarge - url of the largest resized image (up to 1000px by 1000px, uncropped)
- media_type - photo or floorplan
- sort_order - the order the the photo is intended to be displayed in
price - all prices in USD. for rentals this is the rent for one month. for sales this is the current asking price.
property_type - residential or commercial
source - describes the primary source where the listing data originated
status - describes the current status of the unit with respect to availability, pending applications, etc.
street_address - the street address of the building, modified by address display preferences. see here for more info on display preferences
square_footage
total_rooms
unit_number - the number of the unit within the building. example: “3G” or “2R”
view - if we have data on the view from the unit it will appear here with one of the following possible values: Open View, Partially Obstructed, or Obstructed.
website_marketable - if false, listing cannot be marketed on a website.
private - true if the listing is marked private in Funnel.

Additional fields for rental listings

incentives - describes additional incentives offered by the building’s owner to brokers
min_lease_term - minimum number of months a lease can be signed for
max_lease_term - maximum number of months a lease can be signed for
renter_fee - whether or not a renter signing a lease has to be a broker’s fee

Additional fields for sale listings

common_charges_maintenance_fee - in USD
monthly_taxes - in USD
number_of_shares - number of shares of ownership for buildings with a co-op or cond-op ownership class
percent_of_common_elements - percent of common areas owned for buildings with a co-op or cond-op ownership class
flip_tax
max_financing
tax_deduction

Additional fields for commercial listings

commercial_use - if true the unit is permitted to be used for commercial purposes
electric_cost - for commercial listings only, null otherwise

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.

display_agent
- Accepts and ID of an agent. If the agent has made any edits to the requested listing, such as adding their own photos or description, these will be included with the returned listing. Addtionally, that agent’s contact information will be returned as the contact information for the listings.
include_private
- If this parameter is not included or set to false, attempting to load a private listing via this end point will return a 404 error. If this parameter is set to true, then listings marked private in Funnel will be accessible via this end-point.
- Default value is false
- true or false

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,
    featured: false,
    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 Funnel’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

updated_since
- A UTC formatted timestamp such as2015-06-05T13:45:00. Filters the listings returned to only include available listings that have been updated since the provided date.
listing_type
- rentals default
- sales
property_type
- residential default
- commercial

Authentication

The Listings Sync endpoint is only available using Basic Authentication. Before you use the listings sync endpoint, please confirm with your Funnel representative that your Funnel 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

building_ownership - the ownership class of the building.
- 10 Multi-family
- 20 Condo
- 30 Co-op
- 40 Condop
- 50 Single-family
building_type - the type of building structure.
- 10 High-Rise
- 20 Walk-Up
- 30 Elevator
- 40 Hotel
- 50 Loft
- 60 Townhouse
- 70 Detached House
- 80 Attached House
- 90 Semi-detached House
- 100 Mid-Rise
- 110 Low-Rise
pets - description of what kinds of pets the building’s management company allows.
- 10 No Pets Allowed
- 20 Pets Allowed
- 30 Cats Only
- 40 Dogs Only
- 50 Cats/Small Dogs Allowed
- 60 Pets Allowed Case by Case
status - describes the current status of the unit with respect to availability, pending applications, etc.
- 100 Available
- 200 App Pending
- 210 Offer Pending
- 220 Complete App
- 230 Approved
- 240 Lease Out
- 250 Transfer
- 260 In Contract
- 300 Under Renovation
- 310 Hold
- 320 Lease Break
- 400 Rented
- 410 Sold

API Documentation - Listings

Table of Contents

Listings Search

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/`

Parameters

About Multiple Choice Fields

Filter Paramters

Sort Parameters

Other Parameters

Example Request and Response

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>/`

Additional Parameters

Listings Sync

About Multiple Choice Fields

GET `/api/v2/sync/listings/`

Accepted Filter Parameters & Values

Authentication

Glossary of Listings Sync Object Fields and Accepted Values

API Documentation - Listings

Table of Contents

Listings Search

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/

Parameters

About Multiple Choice Fields

Filter Paramters

Sort Parameters

Other Parameters

Example Request and Response

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>/

Additional Parameters

Listings Sync

About Multiple Choice Fields

GET /api/v2/sync/listings/

Accepted Filter Parameters & Values

Authentication

Pagination

Glossary of Listings Sync Object Fields and Accepted Values

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/`

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

GET `/api/v2/sync/listings/`