getCurrentRates

Get current mortgage rates.

Note: The request is exposed at the following URL:

Input Parameters

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.

Output Parameters

Name Type Description
rates CurrentRate {}

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

Error Codes

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.

UnsupportedProgram

A provided loan program is not supported.

Typedefs

typedef PartnerId

Encoded partner ID, like "RD-EXAMPLE".

Type
string

Struct Types

struct CurrentRate

Current rate for a rate query.

Name Type Description
query RateQueryOutput

The rate query.

rate float

The average rate. This value will be 0.0 if there is no volume.

apr float

The average APR. This value will be 0.0 if there is no volume.

volume int

DEPRECATED

struct PropertyRateBucket

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

union RateLocation

A state.

Name Type Attributes Description
stateAbbreviation StateAbbreviationWithUS
  • optional

The state abbreviation.

zipCode string
  • optional

The zip code. Required if stateAbbreviation is not passed.

struct RateQuery

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.

struct RateQueryOutput

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.

Enum Types

enum CreditScoreRateBucket

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.

enum LoanAmountRateBucket

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.

enum LoanProgram

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

enum LoanToValueRateBucket

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%.

enum LoanType

The loan type reported in a lender review.

Value
Conventional
FHA
VA
USDA
Other
Jumbo

enum StateAbbreviationWithUS

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