API Documentation - Authentication

Table of Contents

Getting your Authorized API Key

To get access to the Funnel listings API please contact your customer service representative. We will create a key for you on request, configured according to your needs.

Your customer service rep will discuss your intended API use to determine if you need a public or private access key. Typically public access keys are appropriate for website frontends and private access keys are required for server-to-server API integration.

API Data Display Preferences

Configuration for how data is displayed in the open listings API. Display preferences are specific to single key. In some cases, you will need more than one key to have API integrations with different display preferences.

• Location Visibility
  • Full Address Visibility default Full address and location information will be displayed on all of your company’s listings accessed via this key.
  • Street Only Visibility Streets and cross streets will be displayed, but building numbers will be hidden.
  • Neighborhood Only Listing neighborhoods will be displayed. Address and streets will be hidden (including cross streets).
• Hide Unit Number default=False - Listing unit numbers will be blank if True.
• Include Broker Info default=False - Listings will include broker specific information that might not be appropriate to show to public users. Specifically the following information is counted as Broker Info: Date and Time of upcoming Open Houses for Open Listings, Unit Access Information including information about how to get the door key to the unit, and information about the Commission Structure of the listing.

Basic Authentication

Requests are made using the HTTP Basic Authentication protocol. The username is your key and the password is blank. See the wikipedia page for more details: HTTP Basic Auth

Example Usage

Unix Shell

curl --user <your_key>:  https://nestiolistings.com/api/v2/listings/residential/rentals/

Python

import requests

response = requests.get('https://nestiolistings.com/api/v2/listings/residential/rentals/', auth=('<your_key>', ''))

AJAX Authentication

Certain API end-points are available to access via AJAX requests, allowing you to call the API directly from Javascript running in the user’s browser. If you’d like this featured enabled for your API key please contact support@funnelleasing.com.

Once this feature is enabled, public access is as simple as just putting the key in the querystring of the URL you’re making the request to.

$.ajax("https://nestiolistings.com/api/v2/listings/residential/rentals/?key=<your_key>",
{
    method: "GET",
    success: function(data, status, XHR) {
        // how is "phrasing" not a thing now?
    },
    error: function(data, status, XHR){
        // something something danger zone
    }
})