ENTITY Documentation Portal
Developer API · ENTITY v3.4.3 · economic fabric

ENTITY Exchange API

Reference target: this page describes the current v3.4.3 release and pins implementation links to the immutable release tag. Route names describe the adoption surface; they are not by themselves evidence that every deployment exposes a turnkey hosted HTTP service.

The adoption layer exposes a compact exchange-facing API over the larger ENTITY market engine. It preserves the market lifecycle while keeping rights, authority, evidence and settlement boundaries explicit.

DCO → INSTRUMENT → LISTING → DISCLOSURE → ORDER / RFQ / AUCTION → PRICE DISCOVERY → TRADE → CLEARING → SETTLEMENT → ENTITLEMENT → USAGE → DERIVED OUTPUT → ECONOMIC CONSEQUENCE

Adoption routes

RoutePurposeDeveloper responsibility
POST /instrumentsDefine or submit a rights instrument.Issuer must control the underlying object/right; instrument terms must be explicit.
POST /listingsPublish an instrument listing.Bind venue/instrument to disclosure evidence and lot/tick constraints.
POST /ordersSubmit a signed order.Use canonical signed intent, replay-resistant nonce and valid participant authority/balance.
POST /rfqCreate a request for quote.Specify venue, instrument, side, quantity and expiry; quotes remain separate signed records.
POST /auctionsExecute the call-auction profile.Preserve deterministic execution evidence and market-policy constraints.
POST /settlementsSettle an executed trade.Do not infer external money movement; use authorized verification/payment evidence where required.
GET /positionsQuery rights-unit balances and entitlements.Interpret positions as governed rights state, not ownership of source bytes by default.
GET /market-dataQuery venue market observations.Market observations are evidence/observations, not accounting fair value or legal determinations.

Execution models

ORDER_BOOK

Signed BUY/SELL orders with limit price, time-in-force, quantity, remaining quantity, status, receipt time and cancellation records.

CALL_AUCTION

Batch/call-auction execution profile for venue-controlled price discovery under explicit policy.

RFQ

Signed requests, signed quotes, expiry and explicit acceptance for negotiated execution without losing machine-verifiable lineage.

Instrument classes

SPOT_LICENSESUBSCRIPTIONCOMPUTE_TO_DATAPROCUREMENTCONTRIBUTIONSECONDARY_LICENSE

Market state developers can query or preserve

Under the API surface the exchange engine maintains venues, instruments, balances, listings, disclosures, orders, trades, clearing, entitlements, usage, revenue rules/rule sets, trade-revenue bindings, surveillance, RFQs, quotes, acceptances, cancellations, settlement-verifier authorizations and payment attestations.

Core invariants

SDK status

The adoption SDK reports the market engine as preserved, exposes the market lifecycle above and surfaces whether the engine maintains the invariant that rights—not information bytes—are the traded economic object.