BUSINESS CASES
Where this module fits
- market discovery
- order and position monitoring
- trade and balance reconciliation
v2OPERATE · MODULE 09
Discover markets and read owner-scoped trading projections behind a stable interface while market and matching authority remain independently controlled.
BUSINESS CASES
PRIMARY CONSUMERS
PREREQUISITES
RECOMMENDED WORKFLOW
read venue-scoped market rules and availability
prepare a valid owner-scoped request
reconcile accepted commands through orders, trades, positions, and balances
MODULE CONTRACTS
Each operation states whether its request shape is authoritative in OpenAPI, reviewed as a planning profile, or intentionally left as an outline pending an owner schema.
/api/v2/auth/federation/{provider}/exchangesVerify and consume a provider authorization response once, then issue a Hybrid session or complete an explicit account link.›POSTExchange workload assertion/api/v2/auth/workload-token-exchangesVerify a one-time Ed25519 private-key JWT assertion and issue a refreshless, network-bound scoped workload bearer with a 15-minute default and network-specific lifetime cap.›GETGet symbol watchlist/api/v2/me/watchlistList symbol watchlist through the authoritative trust service boundary.›DELETERemove symbol from watchlist/api/v2/me/watchlist/{market_id}Apply the requested transition to symbol from watchlist through the authoritative trust service boundary.›PUTAdd symbol to watchlist/api/v2/me/watchlist/{market_id}Apply the requested transition to add symbol to watchlist through the authoritative trust service boundary.›POSTCancel dex order/api/v2/dex/cancelPlanned capability: apply the requested transition to dex order through the authoritative market and trading service boundary.›POSTCancel all dex orders/api/v2/dex/cancel_allPlanned capability: apply the requested transition to all dex orders through the authoritative market and trading service boundary.›GETGet dex candle data/api/v2/dex/market_chartPlanned capability: list dex candle data through the authoritative market and trading service boundary.›GETGet dex order/api/v2/dex/order_metaPlanned capability: list dex order through the authoritative market and trading service boundary.›GETGet dex trade/api/v2/dex/trade_metaPlanned capability: list dex trade through the authoritative market and trading service boundary.›GETGet all dex trades/api/v2/dex/tradesPlanned capability: return the lifecycle history for all dex trades through the authoritative market and trading service boundary.›GETGet dex orderbook/api/v2/markets/{market_id}/order-bookReturn a bounded, venue-specific aggregation of current bid and ask price levels for one canonical market as an informational snapshot, not an executable quote.›GETGet all dex orders/api/v2/ordersList the authenticated owner's orders within one authoritative venue, with optional market and lifecycle filters plus opaque cursor pagination for monitoring and reconciliation.›POSTCreate dex order/api/v2/ordersValidate and submit an owner-scoped order instruction to the selected venue under current market, risk, authorization, idempotency, and operational-admission controls.›GETList collateral balances/api/v2/balancesReturn purpose-limited available and reserved collateral balances.›GETList markets/api/v2/marketsList canonical market definitions for the DEX, securities, or virtual venue without embedding prices, order books, or user state.›GETGet market/api/v2/markets/{market_id}Return one canonical venue-scoped market definition without embedding prices, order books, or user state.›GETList candles/api/v2/markets/{market_id}/candlesAggregate bounded venue-scoped trades into deterministic OHLCV intervals.›GETList market events/api/v2/markets/{market_id}/eventsReturn sequenced venue events for one canonical market.›GETGet funding rates/api/v2/markets/{market_id}/funding-ratesReturn the configured funding rate for a perpetual market.›GETGet restrictions/api/v2/markets/{market_id}/restrictionsReturn owner-specific matching restrictions without exposing other traders.›GETList market trades/api/v2/markets/{market_id}/tradesReturn a bounded recent execution window for one canonical venue-scoped market with duplicate matching sides collapsed.›GETGet order/api/v2/orders/{order_uuid}Return an order, fills, fees, cancellation state, and retained execution evidence.›POSTCancel order/api/v2/orders/{order_uuid}/cancellationsRequest cancellation of an eligible open order.›POSTReplace order/api/v2/orders/{order_uuid}/replacementsAtomically cancel and replace an eligible order with revised terms.›POSTCancel all orders/api/v2/orders/cancellationsCancel every eligible owner-scoped order, optionally restricted to one market and venue.›GETList positions/api/v2/positionsList current and historical trading positions and realized/unrealized performance.›POSTClose position/api/v2/positions/{market_id}/closuresSubmit a reduce-only market command whose side is derived from the live owner-scoped position.›GETList trades/api/v2/tradesList authenticated trade executions with market, order, settlement, and fee filters.›GETGet trade/api/v2/trades/{trade_uuid}Return one exact owner-scoped trade execution.›GETGet last trade/api/v2/markets/{market_id}/last-tradeReturn the latest distinct execution for one canonical venue-scoped market, or an explicit null when no trade exists.›POSTCancel mtf order/api/v2/exchange/cancelPlanned capability: apply the requested transition to mtf order through the authoritative market and trading service boundary.›POSTCancel all mtf orders/api/v2/exchange/cancel_allPlanned capability: apply the requested transition to all mtf orders through the authoritative market and trading service boundary.›GETGet mtf liquidity pool events/api/v2/exchange/eventsPlanned capability: return the lifecycle history for mtf liquidity pool events through the authoritative market and trading service boundary.›GETGet mtf funding rates/api/v2/exchange/fundingratesPlanned capability: list mtf funding rates through the authoritative market and trading service boundary.›GETGet mtf order details/api/v2/exchange/order_metaPlanned capability: list mtf order details through the authoritative market and trading service boundary.›GETGet mtf orderbook restrictions/api/v2/exchange/orderbook_restrictionsPlanned capability: return the current posture for mtf orderbook restrictions through the authoritative market and trading service boundary.›GETGet mtf trade details/api/v2/exchange/trade_metaPlanned capability: list mtf trade details through the authoritative market and trading service boundary.›GETGet all mtf trades/api/v2/exchange/tradesPlanned capability: return the lifecycle history for all mtf trades through the authoritative market and trading service boundary.›POSTCancel virtual order/api/v2/virtex/cancelPlanned capability: apply the requested transition to virtual order through the authoritative market and trading service boundary.›POSTCancel all virtual orders/api/v2/virtex/cancel_allPlanned capability: apply the requested transition to all virtual orders through the authoritative market and trading service boundary.›GETGet virtual order details/api/v2/virtex/order_metaPlanned capability: list virtual order details through the authoritative market and trading service boundary.›GETGet virtual trade details/api/v2/virtex/trade_metaPlanned capability: list virtual trade details through the authoritative market and trading service boundary.›GETGet all virtual trades/api/v2/virtex/tradesPlanned capability: return the lifecycle history for all virtual trades through the authoritative market and trading service boundary.›GETList collections/api/v2/asset-collectionsList digital-asset collections and publication state.›POSTCreate collection/api/v2/asset-collectionsPlanned capability: create a collection with authority, metadata, royalty, and visibility policy.›GETGet collection/api/v2/asset-collections/{collection_uuid}Return one public collection identity, classification, metadata commitment, and lifecycle state.›POSTPublish collection/api/v2/asset-collections/{collection_uuid}/publicationsPlanned capability: publish an eligible collection and freeze its public identity.›GETList market listings/api/v2/asset-listingsPlanned capability: list active and historical asset listings, orders, and settlement posture.›POSTCreate listing/api/v2/asset-listingsPlanned capability: create a signed asset listing with quantity, unit price, settlement currencies, tolerance, and expiry.›POSTCancel listing/api/v2/asset-listings/{listing_uuid}/cancellationsPlanned capability: cancel an active listing and preserve an immutable lifecycle record.›POSTReplace listing/api/v2/asset-listings/{listing_uuid}/replacementsPlanned capability: atomically cancel and replace an active listing with revised market terms.›POSTReconcile market delivery/api/v2/asset-market-orders/{order_uuid}/reconciliationsPlanned capability: verify one Commerce-owned payment confirmation against an asset-market order and, only when every immutable term matches, request atomic delivery of the order's reserved items.›GETGet mint evidence/api/v2/asset-mints/{mint_uuid}Return one minimized mint receipt and its cross-checked public proof.›GETGet asset proof/api/v2/asset-proofs/{proof_uuid}Return one retained public asset proof for independent verification and audit correlation.›GETList assets/api/v2/assetsList published asset identities, exact supply projections, lifecycle state, and collection membership.›POSTIssue asset/api/v2/assetsPlanned capability: create an asset issuance intent with supply, precision, authority, metadata, and compliance policy.›GETGet asset/api/v2/assets/{asset_uuid}Return canonical public metadata, precision, exact supply projection, collection binding, lifecycle state, and timestamps.›POSTBurn asset/api/v2/assets/{asset_uuid}/burnsPlanned capability: create a governed burn operation against eligible holdings.›GETList asset history/api/v2/assets/{asset_uuid}/historyReturn ordered, minimized public lifecycle events for one published asset.›POSTMint asset/api/v2/assets/{asset_uuid}/mintsPlanned capability: create a governed mint operation within the asset's cap and authority policy.›GETList asset proofs/api/v2/assets/{asset_uuid}/proofsReturn the retained public proof chain for one published asset.›POSTPublish asset/api/v2/assets/{asset_uuid}/publicationsPlanned capability: publish an eligible asset and its immutable public metadata.›GETGet all security tokens/api/v2/tokens/availablePlanned capability: list all security tokens through the authoritative digital-asset registry service boundary.›GETGet token buying power/api/v2/tokens/buying_powerPlanned capability: list token buying power through the authoritative digital-asset registry service boundary.›GETGet token details/api/v2/tokens/detailsPlanned capability: list token details through the authoritative digital-asset registry service boundary.›GETGet token inventory/api/v2/tokens/inventoryPlanned capability: list token inventory through the authoritative digital-asset registry service boundary.›POSTMint a new security token/api/v2/tokens/mintPlanned capability: apply the requested transition to mint a new security token through the authoritative digital-asset registry service boundary.›GETGet token performance/api/v2/tokens/performancePlanned capability: list token performance through the authoritative digital-asset registry service boundary.›GETGet token quote/api/v2/tokens/quotePlanned capability: list token quote through the authoritative digital-asset registry service boundary.›GETRedeem a security token/api/v2/tokens/redeemPlanned capability: list redeem a security token through the authoritative digital-asset registry service boundary.›GETGet all securities/api/v2/tokens/securitiesPlanned capability: list all securities through the authoritative digital-asset registry service boundary.›GETGet all predictions/api/v2/prediction/allPlanned capability: list all predictions through the authoritative prediction service boundary.›POSTCreate new prediction/api/v2/prediction/createPlanned capability: apply the requested transition to new prediction through the authoritative prediction service boundary.›GETGet prediction details/api/v2/prediction/detailsPlanned capability: list prediction details through the authoritative prediction service boundary.›GETGet prediction performance/api/v2/prediction/performancePlanned capability: list prediction performance through the authoritative prediction service boundary.›GETList contracts/api/v2/admin/prediction-marketsPlanned capability: list prediction contracts with lifecycle, oracle, exposure, dispute, and resolution-review posture.›GETGet control record/api/v2/admin/prediction-markets/{prediction_id}Planned capability: read one prediction contract's governed rules, oracle policy, exposure, disputes, and retained review evidence.›GETGet evidence/api/v2/admin/prediction-markets/{prediction_id}/evidencePlanned capability: return immutable rule, oracle, review, dispute, lifecycle, and resolution evidence for one prediction contract.›POSTRecord lifecycle decision/api/v2/admin/prediction-markets/{prediction_id}/lifecycle-decisionsPlanned capability: record a version-bound, attributed lifecycle decision without changing trading authority or traffic.›POSTRecord resolution/api/v2/admin/prediction-markets/{prediction_id}/resolutionsPlanned capability: record a governed outcome resolution bound to authoritative oracle and independent-review evidence.›GETList markets/api/v2/explorer/markets/{liquidity_pool_uuid}Return markets from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet orders/api/v2/explorer/ordersList orders from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet order details/api/v2/explorer/orders/{order_reference}Return order details from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet order record/api/v2/explorer/orders/{uuid}Return orders uuid from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet trades/api/v2/explorer/tradesReturn the ordered public record for trades from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet trade details/api/v2/explorer/trades/{trade_uuid}Return trade details from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet trade record/api/v2/explorer/trades/{uuid}Return trades uuid from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›