Every API response follows the same top-level structure regardless of loan type.
Top-Level Fields
| Field | Type | Description |
|---|
| returncode | integer | 0 = success; non-zero indicates an error |
| status | string | "success" or "error" |
| loid | integer | Echo of the loid from your request |
| loan_details | object | Echo of the parsed loan parameters including computed LTV |
| pricing_results | array | Ordered array of lender pricing objects (lowest to highest rate) |
pricing_results Object Fields
| Field | Type | Description |
|---|
| lender_name | string | Name of the lending institution. Consistent across all results in a single response (see LoanSifter pricing note in Overview). |
| program_name | string | Product program name (e.g., HomeReady, Jumbo 30-Year Fixed, 7/6 ARM) |
| rate | number | Interest rate (note rate) as a percentage |
| apr | number | Annual Percentage Rate including fees |
| points | number | Discount/origination points. 0 = par; positive = cost; negative = credit |
| monthly_payment | number | Estimated principal + interest payment in USD |
| term | integer | Loan term in years |
| pmi_monthly | number | Monthly PMI in USD (Conventional loans with LTV > 80%) |
| mip_monthly | number | Monthly MIP in USD (FHA loans) |
| va_funding_fee | number | VA funding fee as a decimal (VA loans) |
| funding_fee_amount | number | VA funding fee dollar amount (VA loans) |
| dscr_ratio | number | Minimum DSCR required (Non-QM DSCR loans) |
| prepay_penalty | string | Prepayment penalty schedule (Non-QM loans) |
| io_option | boolean | Interest-only option available (Non-QM loans) |
| arm_caps | string | Cap structure as "initial/periodic/lifetime" (ARM loans). E.g., "5/1/5" |
| index | string | Benchmark index for ARM adjustments (e.g., SOFR) |
| margin | number | Fixed spread added to index at each ARM adjustment |
| fully_indexed_rate | number | Current index + margin; useful for TRID worst-case disclosure (ARM loans) |
| lock_period | integer | Rate lock period in days for this quote |
Comments
0 comments
Please sign in to leave a comment.