⬡ Caravan Guide API Docs
PDF Guide Sign in
Navigation - Changelog

Changelog

All breaking and notable changes to the API are documented here. Breaking changes always introduce a new version path - existing version paths remain available until formally deprecated with a sunset date.

v1.3 - May 2026

Public API documentation. The web docs portal (/subscriber/api-docs/) and help-centre developer articles are now readable without login. Calling API endpoints still requires provisioned credentials.

Partner catalogue cascade and pre-fill.

New Endpoints

  • GET /api/v1/valuations/catalog - Stepwise make → model → year → size → bedroom options for partner dropdowns. Supports bootstrap=1 to hydrate all lists at once and optional pre-fill parameters with per-field validation (selection.provided, valid, canonical).
  • GET /api/v1/valuations/resolve - Resolve alias or trade names to canonical catalogue identity (and optional family_id) before search or pre-fill.

Integration notes

  • Catalogue endpoints return filter values only - no GBP prices. Use /valuations/search after selection.
  • Pre-fill any combination of catalogue params on step or bootstrap calls; invalid values return selection.*.valid: false without failing the request.
  • Size filters accept size_display, sd, or lf+wf. Bedrooms accept __null__ for unknown counts.
  • /valuations/cascade (flat variant list with prices) remains available; interactive dropdowns should prefer /valuations/catalog.

v1.2 - April 2026

New endpoint: health check.

New Endpoints

  • GET /api/v1/health - Unauthenticated platform health check for uptime monitors. Returns database status and platform kill-switch state.

v1.1 - April 2026

New endpoints: history, certificates, announcements, account.

New Endpoints

  • GET /api/v1/valuations/history - Price history across editions for a family. Ideal for charts.
  • GET /api/v1/certificates/history - Certificate issuance history for a caravan family by family_id.
  • GET /api/v1/announcements - Active platform announcements for in-app notification feeds.
  • GET /api/v1/account/me - Authenticated client identity, access tier, scopes, and monthly usage.

v1.0 - April 2026

Initial release.

Authentication

  • API key authentication via X-API-Key header.
  • OAuth 2.0 client_credentials grant via POST /api/v1/oauth/token.
  • Scope-based access control: valuations:read, certificates:read, certificates:write, trust_badge:read.

Valuations

  • GET /api/v1/valuations/search - Full-text valuation search with pagination.
  • GET /api/v1/valuations/cascade - All variants for a manufacturer + model across years.
  • GET /api/v1/valuations/pricing - Current and previous edition pricing with market pulse adjustment.

Certificates

  • GET /api/v1/certificates/verify - Certificate verification by certificate number.
  • POST /api/v1/certificates/issue - Issue certificates (enterprise / write access only) with idempotency support.

Trust Badge

  • GET /api/v1/trust-badge/status - Active trust badge status for a domain.
  • GET /api/v1/trust-badge/verify - Lightweight boolean verification check.

Response Standards

  • All responses use consistent success/error envelopes with meta.request_id.
  • X-Request-Id, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset headers on all authenticated responses.
  • Idempotency support on all POST write endpoints (Idempotency-Key header).

Versioning Policy

A new version path (e.g. /api/v2/) will be introduced when:

  • A response shape or field name changes in a breaking way.
  • A required parameter is added to an existing endpoint.
  • Error code semantics change.

Non-breaking additions (new optional parameters, new response fields, new endpoints) are released in the current version.

Deprecated versions will be announced with a minimum 90-day notice period.