/api/v1/quote-context — that returns finance programs, equipment records, and local context in one authenticated request, so every quote is built on current, source-verified data.
The problem with piecemeal data
Most quoting tools are assembled from static spreadsheets, CRM fields copied from emails, and occasional manual updates. The result is a quoting flow that may look polished but is silently working from outdated lender fees, wrong equipment assumptions, or missed incentive programs. Home Service Data replaces that patchwork with a curated, continuously verified data layer your tool can call at quote time.Recommended approach
For active quoting flows, use the/api/v1/quote-context endpoint as a single bundled call per quote session. You pass the trade vertical, state, county, and the specific measure you are quoting (for example, air_source_heat_pump), and the API returns matching finance programs, equipment catalog records, and the local context needed to build an accurate quote — all in one response.
Valid values for the trade parameter are solar, hvac, roofing, plumbing, and electrical.
Making the request
Response shape
The response envelope wraps a structured payload with four top-level keys.Checking quote_safe before displaying data
Every record in finance[] and equipment[] carries a quote_safe boolean. You must check this flag before presenting any record to a customer or using it in a binding quote calculation.
quote_safe is false or null have not passed the full verification cycle. They may still be useful for internal reference, but you should never present them to customers as confirmed program terms.
Records inside
context{} — such as incentives, climate, and permits — are enrichment data. They provide helpful context for building a complete quote but carry their own quote_safe state. Always check that field on individual context records before using them as binding quote line items.Narrowing results with additional parameters
The endpoint accepts several optional query parameters to narrow the response to exactly what your quoting flow needs.| Parameter | Type | Description |
|---|---|---|
trade | string | solar, hvac, roofing, plumbing, or electrical (default: solar) |
state | string | Two-letter state code, e.g. GA |
county | string | County name, e.g. Fulton |
county_fips | string | Five-digit county FIPS code, alternative to county |
city | string | City name for permit context scoping |
utility | string | Utility provider name for incentive scoping |
measure | string | Measure key, e.g. air_source_heat_pump |
equipment_id | string | Equipment record ID; infers measure automatically |
financier | string | Filter finance records to a specific lender slug |
payment_type | string | Filter by payment type |
term_months | integer | Filter finance records by term length |
equipment_category | string | module, inverter, roofing, hvac, or product |
manufacturer | string | Filter equipment by manufacturer |
sku | string | Filter equipment by SKU or model number |
address | string | Postal address for utility territory resolution |
finance_limit | integer | Max finance records returned (default 25, max 100) |
equipment_limit | integer | Max equipment records returned (default 25, max 100) |
context_limit | integer | Max records returned per context category (default 10, max 50) |
Handling warnings and unresolved requirements
Thecoverage object in the response includes two diagnostic arrays you should surface in your integration logs.
warnings— advisory messages such as “No quote-safe finance rows matched” or “Add state/county to return climate context.” These tell you when a query returned partial data.unresolved_requirements— requirements that could not be resolved for specific context records, prefixed by their category (e.g.,"finance_eligibility: county scope not resolved").
Next steps
Quote Context API Reference
Full parameter list, response schema, and error codes for the quote-context endpoint.
Sync Integration
Seed a local database with a snapshot and stay current with delta polling for zero-latency quote paths.