Leasing Availability API

What is the Leasing Availability API?

The VTS Leasing Availability API is a set of APIs that allow your team to automatically integrate real-time VTS Building and Listing data into your own websites and listing services. This means that VTS becomes the only place you'll need to go to edit or update any information in those places you implement the Leasing Availability API. Additional benefits include...

• Integrate and power your corporate website with real time listing information.
• Remove the dependency of having developers update Building and Listing information.
• Save time by only having to update information in one place (VTS).
• Ensure your corporate website is always accurate thanks to the direct link between it and your real-time availabilities in VTS.

The Leasing Availability API includes:

• Full data set including all VTS Market building and listing attributes (including field data and coordinates) and media (including all images and virtual tours) for any live buildings and listings in a customer account.
• Defined UTM parameters for potential links back to the VTS platform to distinguish API traffic from other visits.

General notes about these APIs

• All APIs are as close to real-time as possible, and should reflect any change in data or image order as soon as they are saved (customer may experience a slight delay of less than 1 minute, however timing can vary based on other production environment traffic)
• For the schema definition and sample values, refer to: Leasing Availability API Schema
• If you do not have access to this API yet, please see https://readme.vts.com/docs/getting-started

API details

There are 3 APIs that can be called...

Fetch set of buildings index request

• This API will return a full set of data for all the buildings in the account that are of status "live" on VTS Market, and some high-level details about the available listings within each building
  • This set of buildings index request allows for the site to pass a city name or a keyword string as a filter - this will limit the response to buildings matching the terms provided
  • Since coordinates are provided, the set of buildings index request can also be used to power a map-based property search page, with the filters potentially being used as part of their search experience (see example below)
  • For field-level details, see the first tab of the schema Leasing Availability API Schema

Fetch specific building show request

• Using a building ID of a live building on market (obtained by calling the set of buildings index API), this API will narrow the dataset to a specific building and its available listings
• This API is more focused and easier to use when you are only interested in a specific property (eg. a custom building website, a building details page on a corporate website, an availabilities page - see examples below)
• For field-level details, see the first tab of the schema Leasing Availability API Schema

Fetch specific listing show request

• Using a listing ID from one of the buildings on market (obtained by calling either the buildings index or show APIs), this API returns an individual listing in more detail
• This API could be used to create a listing details page
• Note that while other APIs are limited to live buildings, this API will return details for off-market listings:
  • This is left up to the customer to handle, as some may still want to display off-market spaces, or avoid possible 404 scenarios on the website (broken pages or links)
  • For field-level details, see the second tab of the schema Leasing Availability API Schema