Skip to documentation content
Price CompareDocs

API reference

Request fields, response objects, and status codes.

In this guide
  1. 1Authenticate server-side
  2. 2Search and compare products
  3. 3Manage price watches
In this guide
  1. 1Authenticate server-side
  2. 2Search and compare products
  3. 3Manage price watches

Canonical v1 contract

The Price Compare OpenAPI contract is the source of truth for generated SDK methods, request models, response models, errors, and examples. SDK clients use the production v1 base URL and a server-side Bearer API key.

Catalog and comparison operations

Use searchProducts to resolve a normalized product identifier, compareProducts for a two-to-four product decision view, getProductComparison for current delivered offers, and getProductPriceHistory for aggregate or store-specific price history.

Price watch operations

List, create, update, and delete price watches with a stable X-Price-Compare-Client-Id header. A watch belongs to that client identifier and can target email delivery at a defined price.

Errors and retries

Validate inputs before sending them. Retry temporary 429 and 5xx responses according to Retry-After and the SDK retry policy; do not retry authentication, validation, or not-found errors without changing the request.

Was this page helpful?