Platform Overview
This page provides a high-level overview of the Lender Price platform and how its API is structured for external integrations.
What Lender Price Does
Lender Price is a mortgage pricing engine that enables lenders, brokers, and their technology partners to:
- Search for rates across multiple lenders and products in real time
- Lock rates to freeze pricing for a loan at a point in time
- Manage the lock lifecycle including extensions, repricing, price concessions, and cancellations
- Calculate mortgage fees (FHA, VA, USDA, mortgage insurance)
- Integrate with a Loan Origination System (LOS) such as Encompass for seamless loan data exchange
API Structure
The Lender Price API is organized around these main areas:
| API Area | Base Path | Purpose |
|---|---|---|
| Pricing | /rest/v1/lp-ppe-api/pricing/ | Rate searches, pricing comparisons |
| Lock | /rest/v1/lp-ppe-api/price-quote/ | Lock events, status transitions, lock lifecycle |
| Pipeline | /rest/v1/pipeline/ | Price quote creation, retrieval, and management |
| Fees | /rest/v1/public-fee-api/ | FHA, VA, USDA, and mortgage insurance fee calculations |
| LOS Integration | /rest/v1/integration/ellie/ | Encompass loan pipeline, loan data exchange |
| Config | /rest/lp-config/ | Pricer configuration, available terms and options |
Core Concepts
Price Quote
The central object in the Lender Price system. A price quote ties together:
- Search -- the pricing criteria used to find rates
- Scenarios -- saved rate selections from search results
- Lock -- the active rate lock (if locked)
- Loan Application -- borrower and loan data (when integrated with an LOS)
Every lock operation references a priceQuoteId.
Search
The pricing criteria container. A search includes:
- Criteria -- loan amount, FICO, LTV, DTI, loan purpose, loan type
- Property -- property type, occupancy, state, county
- Broker Criteria -- compensation plans, rate types, lock period
- Access Criteria -- which lenders and rate periods to include
- MI Criteria -- mortgage insurance parameters
Lock
Represents a rate lock with its full event history. A lock contains an ordered series of lock events, each capturing a status transition (e.g., lock requested, locked, extension requested, repriced, cancelled).
The available status transitions at any point are determined by the lender's locking policy -- use the getNextLockStatus endpoint to see what actions are available.
Rate Period
A pricing window published by a lender. Rate periods contain the rate sheets and pricing adjustments that determine available rates. Rate periods have activation and expiration times -- always check that a rate period is still active before locking.
Common Workflows
Pricing a Loan
- Authenticate and obtain an access token
- Construct a search with your loan criteria
- Call the pricing search endpoint
- Review the returned rate results
See Pricing a Loan for the full guide.
Locking a Rate
- Create a price quote from a pricing search result
- Submit a lock request on the price quote
- Approve or reject the lock (based on locking policy)
- Manage post-lock operations as needed
See Locking with LOS or Locking without LOS for full guides.
Calculating Fees
Call the fee endpoints with loan parameters to get government fee calculations for FHA, VA, and USDA loans. See Mortgage Fees for details.
Authentication
The API supports two authentication methods depending on the endpoint:
| Method | Headers | Used By |
|---|---|---|
| Bearer Token | Authorization: Bearer {accessToken} | Pricing endpoints |
| Secret + Company | secret: {token}, companyid: {companyId} | Lock, pipeline, and integration endpoints |
See Authentication for setup details.