Skip to main content

Search Filters & Options

This page covers how to refine your pricing search by setting loan terms, targeting specific rates, and filtering by product or program.

Setting Loan Terms​

Use termsCriteria to select the loan term in years. This field is not required, but it is preferred for tailoring results.

Single term:

"termsCriteria": [30]

Multiple terms:

"termsCriteria": [30, 20]
note

If termsCriteria is empty, Lender Price defaults to a 30 year term.

Searching for Rates​

There are several fields in the pricing search that control which rates are returned:

  • MultiCriteriaSearchModel.rate -- a single APR rate (e.g., 3.5%)
  • MultiCriteriaSearchModel.rateRange -- a range of rates with to and from values
  • Search.rates -- multiple discrete APR rates (e.g., 2%, 3%, 3.5%)
  • BrokerCriteria.rateTypes -- broad rate categories
  • BrokerCriteria.subRateTypes -- sub-categories

The most commonly used are rateRange and rateTypes.

Setting Rate Values​

Single rate: Use BrokerCriteria.rate to filter for one APR rate.

Multiple rates: Use Search.rates to search for multiple discrete APR rates.

Rate range: Use MultiCriteriaSearchModel.rateRange with to and from fields:

"rateRange": {
  "to": 2.5,
  "from": 2.6
}

This searches for all rates from 2.5 to 2.6, inclusive.

Prioritization​

If rate values are populated in multiple fields, the order of prioritization is: rateRange (highest), then rates, then rate. For example, if the request contains:

"rates": [2.5, 2.6],
"rate": 2.5

the request will search for rates at both 2.5 and 2.6.

Rate Types​

Rate types are broad categories that narrow your search. This is not required.

Rate TypeDescription
AllReturns all rate types
ForBrokerReturns the broker rate
ForCorrespondingReturns the corresponding rate
ForWholesaleReturns the wholesale rate
AsRetailReturns the retail rate

Rate types are set using BrokerCriteria.rateTypes.

Filtering by Product and Program​

The pricing search allows you to filter results by program name, product code, product name, or a combination.

Filter by Program Name​

Use filter.programName (string array). Program names must be an exact match.

Filter by Product Code​

Use filter.productCode (string array). Product codes must be an exact match and are based on the lender configuration.

Filter by Product Name​

Use filter.productName (string array).

Example​

Return results filtered for the program name "30 Year Conv" and product code "7789":

"filter": {
  "programName": ["30 Year Conv"],
  "productCode": [7789]
}

Multiple product codes and names:

"filter": {
  "productCode": [7789, 7790],
  "productName": ["Conv 30 Fixed"]
}
Last updated on