API v1

Deal Clarity API

The same intelligence that powers our consumer product, exposed as five JSON endpoints. Banks, credit unions, insurers, fintechs and marketplaces use it to tell a customer what a vehicle quote really costs — without building the analysis themselves.

Get an API key OpenAPI spec Service status

Products

Deal Analysis API
Scores a written vehicle quote and returns the risk factors, negotiation opportunities and a plain-language explanation.
POST /api/public/v1/deal-analysis

Returns: deal score · risk factors · negotiation opportunities · explanation

Ownership Forecast API
Projects depreciation, maintenance, energy, insurance and total cost of ownership across a 1, 3, 5 or 8 year horizon.
POST /api/public/v1/ownership-forecast

Returns: ownership projections · depreciation estimate · maintenance outlook · cost of ownership

Financing Review API
Evaluates APR and term structure, decodes the monthly payment and projects interest across the life of the loan.
POST /api/public/v1/financing-review

Returns: APR evaluation · loan analysis · payment breakdown · interest projection

Dealer Transparency API
Returns transparency indicators and a confidence level describing how clearly a quote discloses its pricing.
POST /api/public/v1/dealer-transparency

Returns: transparency indicators · confidence level · pricing clarity summary

Walk-Away Recommendation API
Weighs price, financing, transparency and ownership signals into a keep-negotiating / sign / wait / walk-away recommendation.
POST /api/public/v1/walk-away

Returns: recommendation · confidence score · supporting reasons

Quickstart

  1. 1. Create an organization in the partner dashboard and mint a sandbox key.
  2. 2. Send the key as Authorization: Bearer dck_… (or X-API-Key).
  3. 3. POST JSON. Every response carries api_version, request_id, a confidence signal and an estimate disclaimer.
curl -X POST https://deal-clarity-coach.lovable.app/api/public/v1/deal-analysis \
  -H "Authorization: Bearer dck_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vehicle": { "year": 2024, "make": "Toyota", "model": "RAV4", "condition": "new" },
    "quote": {
      "selling_price": 34995,
      "dealer_fees": 899,
      "taxes": 2100,
      "registration": 320,
      "add_ons": 2495,
      "down_payment": 3000,
      "apr_percent": 8.4,
      "term_months": 72,
      "quoted_monthly": 612,
      "quoted_otd": 40809,
      "state_code": "MD"
    }
  }'

Plans and limits

Developer
Sandbox keys, deterministic sample responses, everything you need to build an integration.

100 analyses / month

30 requests / minute

Free

Sandbox keys only

Pay per analysis
Live keys billed per successful analysis. No monthly commitment.

5,000 analyses / month

120 requests / minute

$0.39 per analysis

Subscription
A monthly analysis allowance with higher throughput and usage analytics.

50,000 analyses / month

600 requests / minute

$1,499 / month

Enterprise
Contracted volume, custom limits, dedicated support and review of your integration.

1,000,000 analyses / month

3,000 requests / minute

Contracted pricing

Errors

CodeStatusMeaningFix
missing_api_key401No Authorization header was sent.Send `Authorization: Bearer dck_...`.
invalid_api_key401The key does not exist or was revoked.Rotate the key in the partner dashboard.
scope_not_allowed403The key is not scoped to this product.Enable the product scope on the key.
organization_suspended403The organization is not active.Contact your Deal Clarity account contact.
invalid_request422The request body failed validation.Read `error.details` and correct the fields listed.
rate_limited429Too many requests this minute.Back off and retry after `Retry-After` seconds.
quota_exceeded429The monthly analysis allowance is used up.Upgrade the tier or wait for the next cycle.
internal_error500Unexpected failure on our side.Retry with backoff; include `request_id` when reporting.

Versioning

v1
2026-08-01
  • Initial public release: Deal Analysis, Ownership Forecast, Financing Review, Dealer Transparency and Walk-Away Recommendation.
  • Every response carries `api_version`, `request_id`, `confidence` and an `estimate` disclaimer.
  • Breaking changes will ship as `/api/public/v2/...`; v1 responses stay shape-stable.

Data handling and limits of use