Skip to main content

API reference

The Core engine generates its HTTP and realtime contracts from the same Zod schemas that validate public routes at runtime. The guides in this site explain product behavior; the engine-served schemas are the source of truth for fields and types.

Open generated OpenAPI

Generated contracts​

The documentation site intentionally does not maintain a hand-copied list of routes or types.

Consumer request bodies, ordinary query strings, and response payloads are closed contracts. Send and consume only the documented camelCase fields; unknown fields and retired aliases are rejected rather than silently accepted.

Failures are honest about which side is at fault, with two deliberate exceptions:

  • An order read's verify query proof: malformed or extra proof input is treated as an opaque failed read (404) rather than a distinguishing validation error.
  • A request refused by policy: it answers the same flat 400 invalid_request as a rejected body, because a distinguishable refusal would make order creation a probe. See actions and retries.
ResourceUse it for
GET /v2/docsFetch the OpenAPI 3.1 JSON document.
GET /v2/asyncapiFetch the generated AsyncAPI 3.0 JSON contract for public order WebSockets.

Against the origin this site documents:

curl https://api-beta.wagyu.xyz/v2/docs
curl https://api-beta.wagyu.xyz/v2/asyncapi

What it includes​

  • Asset discovery, swaps, native bridge, orders, points, stats, and public activity.
  • Runtime-validated request and response schemas for each published consumer HTTP operation.
  • Owner-session and read-only destination-proof security rules for order access.
  • Route-specific WebSocket snapshot frames for swaps and native bridge orders.

Operator, treasury, recovery, provider-ingress, integration and key management, integrator, corridor, and development controls are deliberately excluded from this public contract. The two integrator reporting routes are excluded because they read your own customers' orders, not because they are unsupported — their shapes are written out under integrator key. Everything an integrator sends is part of the published consumer schema: the x-integrator-key header and the integratorFeePercent field on quote and create.

See live updates for transport behavior and agent handoff for the recommended reading order.

Build from the schema

Use the OpenAPI document to generate or type client code. Treat examples in the guides as orientation only; the live schema is authoritative for production requests.