Skip to content
Crifine
DocumentationAPI referencePackagesChangelog

API reference

A REST API over HTTPS, JSON in and JSON out, versioned in the path.

Base URLs
Production    https://api.crifine.app/v1     (not deployed yet)
Verification  https://crifine.app/api/v1      (not deployed yet)

Both hosts are reserved and documented. Neither answers today.
  • All monetary sizes are decimal USD, not minor units — size_usd=5000000 is five million dollars.
  • All price levels are decimal in the pool's quote currency.
  • All percentages are signed decimals: -5.58 is 5.58% below the oracle price.
  • All slippage is in basis points: 1135 is 11.35%.
  • All timestamps are RFC 3339 in UTC; all dates are YYYY-MM-DD in UTC.
  • Every result carries method_version and evidence_url.

Payment

Per-call pricing in USDC over x402, or free keyless verification.

Errors

Every error code, and what to do about each one.

Exit estimates

The pre-trade check. The endpoint the product exists for.

Depth history

The recorded series that cannot be backfilled.

Conventions that carry meaning

ConventionWhy it exists
size_usd is required on every estimateThere is no *the* fill price, only a fill price *for a size*.
days_observed on every resultConfidence is a disclosed field, not a marketing posture.
lowest_depth_* rather than avg_depth_*Averages hide the event you are paying to avoid.
evidence_url on every resultA number nobody can reproduce is a marketing claim.