getRates

Zillow Confidential

Get historical mortgage rate data.

Name	Type	Attributes	Description
partnerId	PartnerId		The client's partner ID.
queries	RateQuery {}	optional	A dictionary of queries for which rate data should be returned. The keys are string identifiers chosen by the client. The query results are returned in a dictionary that maps these keys to their corresponding query result. If this parameter is not specified, a single query named "default", whose members are all set to default values, will be issued.
durationDays	int	optional value > 0 value <= 4000	The duration of the window that the rate data should cover, in days. The default is 30.
end	datetime	optional	The end date of the window that the rate data should cover. The default is the current time.
includeCurrentRate	bool	optional	Include the current rate for each query. The default is false.
aggregation	RateAggregation	optional	The rate datetime aggregation.
fill	bool	optional	Fill holes in the data. Default is true.

The client's partner ID.

A dictionary of queries for which rate data should be returned. The keys are string identifiers chosen by the client. The query results are returned in a dictionary that maps these keys to their corresponding query result. If this parameter is not specified, a single query named "default", whose members are all set to default values, will be issued.

The duration of the window that the rate data should cover, in days. The default is 30.

The end date of the window that the rate data should cover. The default is the current time.

Include the current rate for each query. The default is false.

The rate datetime aggregation.

Fill holes in the data. Default is true.

Name	Type	Description
rates	RateData {}	A dictionary of results. The keys correspond to the keys specified by the queries input parameter.

A dictionary of results. The keys correspond to the keys specified by the queries input parameter.

Value	Description
InvalidPartnerId	The specified partner ID is not valid.
UnauthorizedPartner	There is no partner with the specified ID, or the partner is not currently authorized to make API calls.
MethodNotAllowed	The HTTP method is not allowed.
UnsupportedProgram	A provided loan program is not supported.

The specified partner ID is not valid.

There is no partner with the specified ID, or the partner is not currently authorized to make API calls.

The HTTP method is not allowed.

A provided loan program is not supported.

Encoded partner ID, like "RD-EXAMPLE".

Type
string

Property and loan information used to group mortgage rate data.

Name	Type	Attributes	Description
propertyValue	int	value >= 0	The estimated value of the property.
loanAmount	int	value >= 0	The loan amount, in dollars.
location	RateLocation	optional	The location of the property.
homeType	string	optional

The estimated value of the property.

The loan amount, in dollars.

The location of the property.

Rate data for a rate query.

Name	Type	Attributes	Description
query	RateQueryOutput		The rate query.
samples	RateSample []		The average rate samples.
currentRate	RateSample	optional	The current average rate, if requested.

The average rate samples.

The current average rate, if requested.

Name	Type	Attributes	Description
stateAbbreviation	StateAbbreviationWithUS	optional	The state abbreviation.
zipCode	string	optional	The zip code. Required if stateAbbreviation is not passed.

The state abbreviation.

The zip code. Required if stateAbbreviation is not passed.

Parameters for a rate query.

Name	Type	Attributes	Description
refinance	bool	optional	Whether to query for the refinance loan rate. If this member is not specified, its value defaults to false.
stateAbbreviation	StateAbbreviationWithUS	optional	The state abbreviation of the state to query for. If this member is not specified, or if its value is "US", the query is for the national rate.
program	LoanProgram	optional	The loan program to query for. If this member is not specified, its value defaults to Fixed30Year.
loanType	LoanType	optional	The loan type to query for. If this member is not specified, its value defaults to Conventional.
loanAmountBucket	LoanAmountRateBucket	optional	The loan amount bucket to query for. If this member is not specified, its value defaults to Conforming.
loanToValueBucket	LoanToValueRateBucket	optional	The loan-to-value bucket to query for. If this member is not specified, its value defaults to Normal.
creditScoreBucket	CreditScoreRateBucket	optional	The credit score bucket to query for. If this member is not specified, its value defaults to VeryHigh.
propertyBucket	PropertyRateBucket	optional	The property/loan/location bucket to query for. This member overrides the "stateAbbreviation", "loanAmountBucket", and "loanToValueBucket" members.

Whether to query for the refinance loan rate. If this member is not specified, its value defaults to false.

The state abbreviation of the state to query for. If this member is not specified, or if its value is "US", the query is for the national rate.

The loan program to query for. If this member is not specified, its value defaults to Fixed30Year.

The loan type to query for. If this member is not specified, its value defaults to Conventional.

The loan amount bucket to query for. If this member is not specified, its value defaults to Conforming.

The loan-to-value bucket to query for. If this member is not specified, its value defaults to Normal.

The credit score bucket to query for. If this member is not specified, its value defaults to VeryHigh.

The property/loan/location bucket to query for. This member overrides the "stateAbbreviation", "loanAmountBucket", and "loanToValueBucket" members.

Parameters for a rate query in an output struct.

Name	Type	Attributes	Description
refinance	bool	optional	Whether to query for the refinance loan rate. If this member is not specified, its value defaults to false.
stateAbbreviation	StateAbbreviationWithUS	optional	The state abbreviation of the state to query for. If this member is not specified, or if its value is "US", the query is for the national rate.
program	LoanProgram		The loan program to query for.
loanType	LoanType		The loan type to query for.
loanAmountBucket	LoanAmountRateBucket		The loan amount bucket to query for.
loanToValueBucket	LoanToValueRateBucket		The loan-to-value bucket to query for.
creditScoreBucket	CreditScoreRateBucket		The credit score bucket to query for.

Whether to query for the refinance loan rate. If this member is not specified, its value defaults to false.

The state abbreviation of the state to query for. If this member is not specified, or if its value is "US", the query is for the national rate.

The loan program to query for.

The loan type to query for.

The loan amount bucket to query for.

The loan-to-value bucket to query for.

The credit score bucket to query for.

A single rate data sample (with volume).

Name	Type	Description
time	datetime	The rate sample's datetime.
rate	float	The rate.
apr	float	The APR.
volume	int	DEPRECATED

The rate sample's datetime.

Credit score buckets used to group mortgage rate data.

Value	Description
Low	Less than 680 credit score.
High	At least 680 but less than 740 credit score.
VeryHigh	At least 740 credit score.

Less than 680 credit score.

At least 680 but less than 740 credit score.

At least 740 credit score.

Loan amount buckets used to group mortgage rate data.

Value	Description
Micro	Less than $100,000 loan amount.
SmallConforming	At least $100,000 but less than $200,000 loan amount.
Conforming	At least $200,000 but less than the national conforming loan amount.
SuperConforming	At least the national conforming loan limit but less than the county-specific minimum jumbo loan amount.
Jumbo	At least the county-specific minimum jumbo loan amount.

Less than $100,000 loan amount.

At least $100,000 but less than $200,000 loan amount.

At least $200,000 but less than the national conforming loan amount.

At least the national conforming loan limit but less than the county-specific minimum jumbo loan amount.

At least the county-specific minimum jumbo loan amount.

Types of loan program that a borrower can express interest in. These values are not comprehensive or orthogonal.

Value
Fixed30Year
Fixed20Year
Fixed15Year
Fixed10Year
ARM3
ARM5
ARM7
HomeEquity30Year
HomeEquity30YearDueIn15
HomeEquity15Year
HELOC20Year
HELOC15Year
HELOC10Year
LowOrNoDown
InterestOnly

Loan-to-value buckets used to group mortgage rate data.

Value	Description
Normal	Less than 80% loan-to-value. For purchase loans, this corresponds to a down payment of 20% or more.
High	At least 80% but less than 95% loan-to-value. For purchase loans, this corresponds to a down payment of at least 5% but less than 20%.
VeryHigh	At least 95% loan-to-value. For purchase loans, this corresponds to a down payment of less than 5%.

Less than 80% loan-to-value. For purchase loans, this corresponds to a down payment of 20% or more.

At least 80% but less than 95% loan-to-value. For purchase loans, this corresponds to a down payment of at least 5% but less than 20%.

At least 95% loan-to-value. For purchase loans, this corresponds to a down payment of less than 5%.

The loan type reported in a lender review.

Value
Conventional
FHA
VA
USDA
Other
Jumbo

A rate datetime aggregation.

Value
Hourly
Daily
Weekly
Monthly

US state and territory abbreviations plus "US".

Value	Description
AK	Alaska
AL	Alabama
AR	Arkansas
AS	American Samoa
AZ	Arizona
CA	California
CO	Colorado
CT	Connecticut
DC	Washington, D.C.
DE	Delaware
FL	Florida
GA	Georgia
GU	Guam
HI	Hawaii
IA	Iowa
ID	Idaho
IL	Illinois
IN	Indiana
KS	Kansas
KY	Kentucky
LA	Louisiana
MA	Massachusetts
MD	Maryland
ME	Maine
MH	Marshall Islands
MI	Michigan
MN	Minnesota
MO	Missouri
MP	Northern Mariana Islands
MS	Mississippi
MT	Montana
NC	North Carolina
ND	North Dakota
NE	Nebraska
NH	New Hampshire
NJ	New Jersey
NM	New Mexico
NV	Nevada
NY	New York
OH	Ohio
OK	Oklahoma
OR	Oregon
PA	Pennsylvania
PR	Puerto Rico
RI	Rhode Island
SC	South Carolina
SD	South Dakota
TN	Tennessee
TX	Texas
UT	Utah
VA	Virgina
VI	Virgin Islands
VT	Vermont
WA	Washington
WI	Wisconsin
WV	West Virginia
WY	Wyoming
US	United States

Northern Mariana Islands

getRates

Input Parameters

Output Parameters

Error Codes

Typedefs

typedef PartnerId

Struct Types

struct PropertyRateBucket

struct RateData

union RateLocation

struct RateQuery

struct RateQueryOutput

struct RateSample

Enum Types

enum CreditScoreRateBucket

enum LoanAmountRateBucket

enum LoanProgram

enum LoanToValueRateBucket

enum LoanType

enum RateAggregation

enum StateAbbreviationWithUS