VTS Appraisals API
The Appraisals API from VTS — 2 operation(s) for appraisals.
OpenAPI Specification
openapi: 3.0.2
info:
title: VTS Lease Account Admin Appraisals API
version: v1
description: VTS Lease REST API — the commercial real estate leasing, asset management, and portfolio data surface of the VTS platform. Resources include assets, spaces, leases, deals, deal terms, lease terms, financials, budgets, tenants, buildings, listings, and the Leasing Availability API. Harvested verbatim from the VTS developer portal (readme.vts.com) per-operation OpenAPI fragments.
contact:
name: VTS API Support
url: https://readme.vts.com/
termsOfService: https://www.vts.com/services-terms
servers:
- url: https://api.vts.com
- url: https://sandbox.vts.com
description: Sandbox
security:
- basic_auth: []
tags:
- name: Appraisals
paths:
/api/v1/appraisals:
get:
summary: Fetches appraisals
tags:
- Appraisals
security:
- basic_auth: []
parameters:
- name: page[size]
in: query
required: false
schema:
type: integer
- name: page[before]
in: query
required: false
schema:
type: string
- name: page[after]
in: query
required: false
schema:
type: string
responses:
'200':
description: Returns list of Appraisals
content:
application/json:
schema:
type: object
properties:
type:
type: string
example: appraisals
id:
type: string
example: '1'
attributes:
type: object
properties:
analysis_type:
type: string
example: appraisal
description: The proposal type of the appraisal
created_at:
type: string
example: '2021-12-08T16:28:22.179486Z'
format: date-time
description: The timestamp when this appraisal was created
commencement_date:
type: string
example: '2021-12-08'
format: date
description: Start of the lease. Usually designates when the tenant is entitled to the space.
concessions:
type: string
example: '0.0'
description: Total concessions on the deal
description:
type: string
nullable: true
example: Some text
description: A description of the appraisal
entered_date:
type: string
example: '1'
description: When the deal term was entered
npv_discount_rate:
type: string
nullable: true
example: '1.0'
description: Net Present Value discount rate
payback:
type: number
example: 1
description: The number of months it takes for the landlord to earn back what they had to pay out as costs of the deal
structure:
type: string
example: full service
description: Rent and recovery structure label
calculated_metrics:
type: object
properties:
ner_override:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- description: Net Effective Rent as a percent of NER of appraisal
npv_per_area:
allOf:
- $ref: '#/components/schemas/measure_money_area'
- description: The present value of the net cash flow given the time value of money
total_net_cash_flow:
allOf:
- $ref: '#/components/schemas/measure_money'
- description: Total cash inflows minus outflows per the terms over the lifetime of the lease
internal_rate_of_return:
type: string
nullable: true
example: '100.0'
description: The return on money spent for the term of the lease
percentage_rents:
$ref: '#/components/schemas/percentage_rents'
other_incomes:
$ref: '#/components/schemas/other_incomes'
reimbursable_expenses:
type: array
items:
type: object
properties:
type:
type: string
example: OperationalExpense
enum:
- OperationalExpense
- RealEstateTax
- ReimbursableExpenseCleaning
- ReimbursableExpenseInsurance
- ReimbursableExpenseMarketing
- ReimbursableExpenseOm
- ReimbursableExpenseOther
- ReimbursableExpenseRepairsAndMaintenance
- ReimbursableExpenseSecurity
- ReimbursableExpenseUtility
- ReimbursableExpenseCam
- ReimbursableExpenseElectric
- ReimbursableExpenseLandscaping
- ReimbursableExpenseManagementFee
description: The type of the reimbursable expense
deprecated: true
expense_type:
type: string
example: OperationalExpense
enum:
- OperationalExpense
- RealEstateTax
- ReimbursableExpenseCleaning
- ReimbursableExpenseInsurance
- ReimbursableExpenseMarketing
- ReimbursableExpenseOm
- ReimbursableExpenseOther
- ReimbursableExpenseRepairsAndMaintenance
- ReimbursableExpenseSecurity
- ReimbursableExpenseUtility
- ReimbursableExpenseCam
- ReimbursableExpenseElectric
- ReimbursableExpenseLandscaping
- ReimbursableExpenseManagementFee
description: The type of the reimbursable expense
recovery_method:
type: string
example: gross
enum:
- gross
- net
- amount
- modified_gross
description: The calculation method of the recovery amount for the reimbursable expense
expense_growth_rate:
allOf:
- $ref: '#/components/schemas/measure_percentage'
- description: The expenses will grow by this rate every 12 months after the lease commencement date.
expense_amount:
type: number
format: float
example: 10
description: The amount of the reimbursable expense
deprecated: true
expense_amount_with_units:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- description: The amount of the reimbursable expense
recovery_amount:
type: number
example: 5
description: The amount of reimbursable expense that will be paid to landlord by the tenant
deprecated: true
recovery_amount_with_units:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- description: The amount of reimbursable expense that will be paid to landlord by the tenant with recovery type modified_gross
expense_stop:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- description: The expense stop of the reimbursable expense. Only applies for expenses with recovery type modified_gross
description:
type: string
example: Description
description: The description of reimbursable expense
base_rents:
$ref: '#/components/schemas/base_rents'
commissions:
$ref: '#/components/schemas/commissions'
costs:
$ref: '#/components/schemas/costs'
free_rents:
allOf:
- $ref: '#/components/schemas/free_rents'
- properties:
recovery_type:
type: string
enum:
- net
- gross
example: gross
description: 'net: percent of net base rent; gross: percent of gross base rent and recoveries.'
deprecated: true
percent_free:
type: number
format: float
example: 1.5
description: Discount as a percentage value of rent
deprecated: true
duration:
type: number
example: 1
description: The number of months in which the free rent applies
deprecated: true
net_effective_rent:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- properties:
unit:
example: USD/sf/yr
unit_components:
properties:
period:
enum:
- yr
description: 'Possible values: ''yr'''
description: The normalized value a tenant will pay per period to the landlord over the length of a lease considering Net Present Value. Returned in money/area/year units
rent_escalations:
$ref: '#/components/schemas/rent_escalations'
rentable_size:
allOf:
- $ref: '#/components/schemas/measure_area'
- description: The area of the tenants rented Space.
security_deposit:
allOf:
- $ref: '#/components/schemas/measure_money'
- properties:
security_deposit_type:
type: string
example: letter_of_credit
description: The type of the security deposit
description: Value and currency of the appraisal's security deposit
total_deal_value:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- properties:
magnitude:
example: 35
unit:
example: USD/sf/yr
unit_components:
properties:
period:
enum:
- yr
description: 'Possible values: ''yr'''
total_lease_term:
$ref: '#/components/schemas/measure_period'
tenant_improvements:
type: array
items:
description: Each Tenant Improvement
type: object
properties:
allowance_unit:
type: string
example: rsf
description: Tenant Improvements allowance unit
allowance:
type: number
format: float
example: 0
description: Tenant Improvements allowance
occurrence_month:
type: number
example: 1
description: Tenant Improvements occurrence month. Possible values are between 1 and the number of months in the budget
description:
type: string
nullable: true
example: Some text
description: Tenant Improvements description
building_improvements:
type: array
items:
description: Each Building Improvement
type: object
properties:
allowance_unit:
type: string
example: rsf
description: Building Improvements allowance unit
allowance:
type: number
format: float
example: 0
description: Building Improvements allowance
occurrence_month:
type: number
example: 1
description: Building Improvements occurrence month. Possible values are between 1 and the number of months in the budget
description:
type: string
nullable: true
example: Some text
description: Building Improvements description
total_rent:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- properties:
magnitude:
example: 35
unit:
example: USD/sf/mo
unit_components:
properties:
period:
enum:
- mo
description: 'Possible values: ''mo'''
description: Amount of income that will be realized as "rent". Total value of Base Rent + Escalations - Free Rent
relationships:
type: object
properties:
space:
type: object
properties:
data:
type: object
nullable: true
properties:
id:
type: string
example: '12345'
type:
type: string
enum:
- spaces_office
- spaces_retail
- spaces_industrial
- spaces_miscellaneous
example: spaces_office
links:
type: object
properties:
related:
type: string
format: uri
description: Only present for space-level appraisals
'403':
description: API not authorized for use
content:
application/json:
schema:
$ref: '#/components/schemas/errors_object'
operationId: get_api-v1-appraisals
/api/v1/appraisals/{id}:
get:
summary: Retrieves specific appraisals
tags:
- Appraisals
security:
- basic_auth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Returns requested appraisal if it exists
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: appraisals
id:
type: string
example: '1'
attributes:
type: object
properties:
analysis_type:
type: string
example: appraisal
description: The proposal type of the appraisal
created_at:
type: string
example: '2021-12-08T16:28:22.179486Z'
format: date-time
description: The timestamp when this appraisal was created
commencement_date:
type: string
example: '2021-12-08'
format: date
description: Start of the lease. Usually designates when the tenant is entitled to the space.
concessions:
type: string
example: '0.0'
description: Total concessions on the deal
description:
type: string
nullable: true
example: Some text
description: A description of the appraisal
entered_date:
type: string
example: '1'
description: When the deal term was entered
npv_discount_rate:
type: string
nullable: true
example: '1.0'
description: Net Present Value discount rate
payback:
type: number
example: 1
description: The number of months it takes for the landlord to earn back what they had to pay out as costs of the deal
structure:
type: string
example: full service
description: Rent and recovery structure label
calculated_metrics:
type: object
properties:
ner_override:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- description: Net Effective Rent as a percent of NER of appraisal
npv_per_area:
allOf:
- $ref: '#/components/schemas/measure_money_area'
- description: The present value of the net cash flow given the time value of money
total_net_cash_flow:
allOf:
- $ref: '#/components/schemas/measure_money'
- description: Total cash inflows minus outflows per the terms over the lifetime of the lease
internal_rate_of_return:
type: string
nullable: true
example: '100.0'
description: The return on money spent for the term of the lease
percentage_rents:
$ref: '#/components/schemas/percentage_rents'
other_incomes:
$ref: '#/components/schemas/other_incomes'
reimbursable_expenses:
type: array
items:
type: object
properties:
type:
type: string
example: OperationalExpense
enum:
- OperationalExpense
- RealEstateTax
- ReimbursableExpenseCleaning
- ReimbursableExpenseInsurance
- ReimbursableExpenseMarketing
- ReimbursableExpenseOm
- ReimbursableExpenseOther
- ReimbursableExpenseRepairsAndMaintenance
- ReimbursableExpenseSecurity
- ReimbursableExpenseUtility
- ReimbursableExpenseCam
- ReimbursableExpenseElectric
- ReimbursableExpenseLandscaping
- ReimbursableExpenseManagementFee
description: The type of the reimbursable expense
deprecated: true
expense_type:
type: string
example: OperationalExpense
enum:
- OperationalExpense
- RealEstateTax
- ReimbursableExpenseCleaning
- ReimbursableExpenseInsurance
- ReimbursableExpenseMarketing
- ReimbursableExpenseOm
- ReimbursableExpenseOther
- ReimbursableExpenseRepairsAndMaintenance
- ReimbursableExpenseSecurity
- ReimbursableExpenseUtility
- ReimbursableExpenseCam
- ReimbursableExpenseElectric
- ReimbursableExpenseLandscaping
- ReimbursableExpenseManagementFee
description: The type of the reimbursable expense
recovery_method:
type: string
example: gross
enum:
- gross
- net
- amount
- modified_gross
description: The calculation method of the recovery amount for the reimbursable expense
expense_growth_rate:
allOf:
- $ref: '#/components/schemas/measure_percentage'
- description: The expenses will grow by this rate every 12 months after the lease commencement date.
expense_amount:
type: number
format: float
example: 10
description: The amount of the reimbursable expense
deprecated: true
expense_amount_with_units:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- description: The amount of the reimbursable expense
recovery_amount:
type: number
example: 5
description: The amount of reimbursable expense that will be paid to landlord by the tenant
deprecated: true
recovery_amount_with_units:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- description: The amount of reimbursable expense that will be paid to landlord by the tenant with recovery type modified_gross
expense_stop:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- description: The expense stop of the reimbursable expense. Only applies for expenses with recovery type modified_gross
description:
type: string
example: Description
description: The description of reimbursable expense
base_rents:
$ref: '#/components/schemas/base_rents'
commissions:
$ref: '#/components/schemas/commissions'
costs:
$ref: '#/components/schemas/costs'
free_rents:
allOf:
- $ref: '#/components/schemas/free_rents'
- properties:
recovery_type:
type: string
enum:
- net
- gross
example: gross
description: 'net: percent of net base rent; gross: percent of gross base rent and recoveries.'
deprecated: true
percent_free:
type: number
format: float
example: 1.5
description: Discount as a percentage value of rent
deprecated: true
duration:
type: number
example: 1
description: The number of months in which the free rent applies
deprecated: true
net_effective_rent:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- properties:
unit:
example: USD/sf/yr
unit_components:
properties:
period:
enum:
- yr
description: 'Possible values: ''yr'''
description: The normalized value a tenant will pay per period to the landlord over the length of a lease considering Net Present Value. Returned in money/area/year units
rent_escalations:
$ref: '#/components/schemas/rent_escalations'
rentable_size:
allOf:
- $ref: '#/components/schemas/measure_area'
- description: The area of the tenants rented Space.
security_deposit:
allOf:
- $ref: '#/components/schemas/measure_money'
- properties:
security_deposit_type:
type: string
example: letter_of_credit
description: The type of the security deposit
description: Value and currency of the appraisal's security deposit
total_deal_value:
allOf:
- $ref: '#/components/schemas/measure_money_area_period'
- properties:
magnitude:
example: 35
unit:
example: USD/sf/yr
unit_components:
properties:
period:
enum:
- yr
description: 'Possible values: ''yr'''
total_lease_term:
$ref: '#/components/schemas/measure_period'
tenant_improvements:
type: array
items:
description: Each Tenant Improvement
type: object
properties:
allowance_unit:
type: string
example: rsf
description: Tenant Improvements allowance unit
allowance:
type: number
format: float
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vts/refs/heads/main/openapi/vts-appraisals-api-openapi.yml