OX
Ordexv1.2
OpenAPI 3.1Gateway observation

REST API Reference (78 Operations)

Interactive testing and parameter documentation for all catalog, order, offer, SafeOps, and gateway operations.

Interactive Operation Playground

Operation:
Mode:
Safety Boundary: Ordex documentation never holds private keys, signs PSBTs, or broadcasts transactions. Operations generate or inspect unsigned artifacts only.
GET/api/ordex/health

The observed verification verdict, not the configuration

Gateway observation

Response Inspector

⚡

Send a request to inspect headers, timing, and schema verdicts.

Deterministic Mock mode runs fully offline.

All Contract Endpoints

79 operations defined
GET/api/ordex/health- The observed verification verdict, not the configuration
GET/api/ordex/protocol- The protocol contract this gateway speaks
GET/api/ordex/catalog- The markets this gateway serves, and what it verifies for each
GET/api/ordex/orders- One page of the orderbook
GET/api/ordex/activity- The appended lifecycle log, newest first
GET/api/ordex/orders/{id}- One order
GET/api/ordex/orders/{id}/artifact- The signed artifact for one live listing
POST/api/ordex/orders/import- Take a signed artifact and verify it
interoperabilityRun In Playground 🚀
POST/api/ordex/orders/openordex-event- Take a signed OpenOrdex event and verify it
interoperabilityRun In Playground 🚀
POST/api/ordex/orders/build- Build the unsigned seller half
POST/api/ordex/orders/publish- Take the signed seller half and publish it
GET/api/ordex/orders/{id}/ownership-challenge- The message a listing owner signs before managing it
POST/api/ordex/orders/{id}/withdraw- Remove a listing, proved by the key owning the output it sells
POST/api/ordex/admin/orders/{id}/withdraw- Operator moderation, separately authenticated
GET/api/ordex/orders/{id}/nostr-envelope- The unsigned kind 802 event announcing this listing
interoperabilityRun In Playground 🚀
POST/api/ordex/orders/{id}/revalidate- Recheck one order against both authorities
POST/api/ordex/orders/{id}/quote- Compose the buyer half and state the exact terms
POST/api/ordex/orders/{id}/preflight- Verify a signed purchase and ask the node whether it would accept it
POST/api/ordex/orders/{id}/replace- Replace a live ask with a freshly signed one for the same output
POST/api/ordex/orders/batch-purchase- Compose several live asks into one transaction
POST/api/ordex/orders/batch-preflight- Verify a signed batch and ask the node about the exact bytes
GET/api/ordex/offers- One page of the offer book
POST/api/ordex/offers- Publish a funded offer
GET/api/ordex/offers/{id}- One offer with its lifecycle state and freshness
POST/api/ordex/offers/{id}/revalidate- Recheck one offer against both authorities
POST/api/ordex/offers/{id}/withdraw- Remove an offer from discovery, proved by the recovery key
POST/api/ordex/offers/{id}/acceptance-plan- State the exact acceptance arrangement for one live offer
POST/api/ordex/offers/{id}/preflight- Verify a built acceptance and ask the node
POST/api/ordex/safeops/plans- Build a complete SafeOps plan
GET/api/ordex/safeops/plans/{planId}- One stored SafeOps plan
POST/api/ordex/safeops/plans/{planId}/shield- Refresh the execution shield for a plan
POST/api/ordex/safeops/broadcast- Relay a fully signed transaction after an explicit user broadcast action
GET/api/ordex/safeops/operations/{txid}- Monitor one broadcast operation
POST/api/ordex/safeops/rbf- Plan an RBF replacement of one of your transactions
POST/api/ordex/safeops/cpfp- Plan a CPFP child for one of your stuck transactions
POST/api/ordex/swaps/intents- Publish a signed swap intent
GET/api/ordex/swaps/intents- List live public swap intents
GET/api/ordex/swaps/intents/{intentId}- One swap intent with its live outpoint state
POST/api/ordex/swaps/intents/{intentId}/withdraw- Withdraw a swap intent
POST/api/ordex/swaps/intents/{intentId}/acceptance-plan- Build the one transaction acceptance plan for a taker
GET/api/ordex/swaps/sessions/{sessionId}- One swap session with its signature progress
POST/api/ordex/swaps/sessions/{sessionId}/signatures- Submit one party signed PSBT
POST/api/ordex/swaps/sessions/{sessionId}/preflight- Run node preflight on the fully signed swap
POST/api/ordex/swaps/sessions/{sessionId}/broadcast- Relay the fully signed swap after the explicit user broadcast action
POST/api/ordex/swaps/private- Store an encrypted private swap link
GET/api/ordex/swaps/private- List the caller stored private swap envelopes
GET/api/ordex/swaps/private/{privateId}- Fetch one encrypted private swap envelope
DELETE/api/ordex/swaps/private/{privateId}- Destroy an encrypted private swap envelope
GET/api/ordex/events- Keyset paginated event history
GET/api/ordex/events/stream- Server sent event stream of live events
GET/api/ordex/events/checkpoint- The current stream sequence and lag
POST/api/ordex/webhooks/subscriptions- Create a webhook subscription
GET/api/ordex/webhooks/subscriptions- List your webhook subscriptions
GET/api/ordex/webhooks/subscriptions/{subscriptionId}- One webhook subscription
PATCH/api/ordex/webhooks/subscriptions/{subscriptionId}- Update, pause, or resume a subscription
DELETE/api/ordex/webhooks/subscriptions/{subscriptionId}- Delete a webhook subscription
POST/api/ordex/webhooks/subscriptions/{subscriptionId}/rotate-secret- Rotate the signing secret
POST/api/ordex/webhooks/subscriptions/{subscriptionId}/verify- Answer the endpoint challenge
POST/api/ordex/webhooks/subscriptions/{subscriptionId}/test- Send a signed test delivery
GET/api/ordex/webhooks/deliveries- Delivery history with attempt detail
POST/api/ordex/webhooks/deliveries/{deliveryId}/replay- Replay one delivery
POST/api/ordex/collections/manifests- Publish a creator signed collection manifest
GET/api/ordex/collections/manifests- List published manifests
GET/api/ordex/collections/manifests/{manifestId}- One collection manifest
GET/api/ordex/collections/manifests/{manifestId}/proofs/{memberIdentity}- A membership proof for one member
POST/api/ordex/collections/manifests/{manifestId}/revisions- Supersede or revoke a manifest
GET/api/ordex/collections/{collectionId}/provenance- The full provenance record of a collection
GET/api/ordex/heritage/readiness- Whether the Counterparty authority currently proves ownership
GET/api/ordex/heritage/assets/{assetId}- One Counterparty asset with its live attachment state
GET/api/ordex/heritage/assets/{assetId}/utxos- The UTXOs currently carrying an asset
GET/api/ordex/heritage/addresses/{address}/assets- The Counterparty assets of one address
POST/api/ordex/heritage/attach- Compose a user signed attach transaction
POST/api/ordex/heritage/detach- Compose a user signed detach transaction
POST/api/ordex/signing/sessions- Open an offline signing session
GET/api/ordex/signing/sessions- List your signing sessions
GET/api/ordex/signing/sessions/{sessionId}- One signing session
POST/api/ordex/signing/sessions/{sessionId}/signed-result- Import a signed result for verification
POST/api/ordex/signing/verify- Verify a manifest and signed result pair without a session
GET/api/ordex/operations/{operationId}- The receipt a mutation committed under an idempotency key