@this-npm-test-org/connection-optimal-blue
v0.1.3
Published
Mortgage pricing engine: product eligibility, rate quotes, lock management, and investor pricing.
Readme
Optimal Blue Connection
Connects your agent to Optimal Blue for mortgage pricing and product eligibility. Pull rate quotes, check product eligibility, view investor pricing, and monitor lock desk activity. Read-only for quotes; lock requests require confirmation.
Authentication
API key with originator credentials.
api_key— Optimal Blue API keyoriginator_id— Your originator ID in Optimal Blue
Endpoints
Rate Quotes
POST /v1/pricing/quotes— Get rate/price quotes for a loan scenarioGET /v1/pricing/quotes/{id}— Get saved quote detail
Product Eligibility
POST /v1/products/eligible— Check eligible products for loan parametersGET /v1/products/{id}— Get product detail with guidelines
Lock Desk
GET /v1/locks— List pending and confirmed locksPOST /v1/locks— Submit lock request (requires confirmation)
Rules
- Rate limit: 100 requests/minute
- Lock requests always require confirmation with rate, price, and expiration
- The agent compares quotes across investors automatically
- Pricing is point-in-time — the agent notes quote timestamp
- The agent flags when rates have moved significantly since last quote
