Compare API

Return a structured diff of two records or datasets so you can see exactly what changed.

What it does

Surface the differences between two records or datasets.

When to use it

Reach for Compare when you need to answer: “What changed between these two?” It sits in the Understand stage of the catalog — compare records and explain results.

Endpoint & cost

POST /api/v1/compare

Cost: 1 credit. Zaps draw down your shared monthly allowance; requests that fail validation are not charged.

Authentication

Send your key as a bearer token: Authorization: Bearer zap_live_…. See Authentication for key management and the alternate header.

Example request

curl https://zapinner.com/api/v1/compare \
  -H "Authorization: Bearer zap_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{"left":{"status":"open","total":12500},"right":{"status":"paid","total":11840}}'

Every response is structured JSON and includes a request_id. Full field-level request and response schemas for this endpoint live in the OpenAPI spec and the API reference.

Errors & limits

Errors use one consistent shape ( error.code, error.message, request_id). See Errors and Rate limits.

SDK

Compare has typed methods in both the JavaScript and Python SDKs. Both are implemented and package-ready but not yet published to npm / PyPI — until they ship, vendor the package source or install from a git ref, or call the endpoint over HTTPS with the example above.

Try it

Select Compare in the playground to see the request, or run it live with your API key.

Match — Decide whether two records refer to the same real-world entity.
Explain — Get a structured, factor-by-factor explanation of a result.
Extract — Pull caller-declared structured fields out of unstructured text.
Web Extract — Fetch a public web page and extract structured fields from it.
Fuzzy Match — Per-field string-similarity comparison of two records.
Schema Detect — Infer a typed schema object ready to feed into map or validate.
Classify — Single-label classification into caller-declared categories.
Tag — Multi-label tagging: apply every tag whose keywords match.
Profile — Get a per-field profile of any record set in one call.
Statistics — Descriptive statistics for every numeric field.
Missing — Find and quantify missing values per field.
Distributions — Histogram, skew, and outliers for numeric fields.
Quality Score — A composite 0-100 data-quality score with components.
Correlations — Pairwise Pearson correlation across numeric fields.
Trends — Ordinary-least-squares trend, growth, and volatility.
Change Points — Detect level shifts in a numeric series.
Patterns — Discover character-class format patterns per field.
Sentiment — Lexicon-based sentiment with negation handling.
Language — Detect the dominant language of a text.
Entities — Extract emails, phones, money, dates, and proper nouns.
Keywords — Rank the most salient terms in a text.
Text Similarity — Jaccard and cosine similarity between two texts.
Summarize — Extractive summary — pick the most salient sentences.
Topics — Surface recurring terms across a document set.
HTML Extract — Extract title, headings, links, and text from HTML.
Forecast — Project a numeric series forward with a linear model.