GetMonthlyPayments: Make request to Zillow API GetMonthlyPayments Web Service

In ZillowR: R Interface to Zillow Real Estate and Mortgage Data API

Make request to Zillow API GetMonthlyPayments Web Service

Description

For a specific loan amount, the GetMonthlyPayments API returns the estimated monthly payment that includes principal and interest based on today's mortgage rate. The API returns the estimated monthly payment per loan type (30-year fixed, 15-year fixed, and 5/1 ARM). If a ZIP code is entered, the estimated taxes and insurance are returned in the result set.

Usage

GetMonthlyPayments(
  price = NULL,
  down = NULL,
  dollarsdown = NULL,
  zip = NULL,
  zws_id = getOption("ZillowR-zws_id"),
  url = "http://www.zillow.com/webservice/GetMonthlyPayments.htm"
)

Arguments

price	The price of the property for which monthly payment data will be calculated. Required.
down	The percentage of the total property price that will be placed as a down payment. If omitted, a 20% down payment is assumed. If the down payment is less than 20%, a monthly private mortgage insurance amount is specified for each returned loan type.
dollarsdown	The dollar amount that will be placed as a down payment. This amount will be used for the down payment if the 'down' parameter is omitted. If the down payment is less than 20% of the purchase price, a monthly private mortgage insurance amount is specified for each returned loan type.
zip	The ZIP code in which the property is located. If omitted, monthly property tax and hazard insurance data will not be returned.
zws_id	The Zillow Web Service Identifier. Required.
url	URL for the GetMonthlyPayments Web Service. Required.

Value

A named list with the following elements:

request

a list with the request parameters

message

a list of status code(s) and message(s) returned by the API

response

an XMLNode with the API-specific response values. At this time, no further coercion is performed, so you may have to use functions from the XML package to extract the desired output.

Examples

## Not run: 
GetMonthlyPayments(price = 300000L)
GetMonthlyPayments(price = 300000L, down = 10)
GetMonthlyPayments(price = 300000L, dollarsdown = 10000L)
GetMonthlyPayments(price = 300000L, zip = 98109)
## End(Not run)

ZillowR documentation built on May 5, 2022, 9:06 a.m.