Prepare one wallet-signed TradeOrder create from a bound quote.
POST /api/v1/orders/prepare. Prepare one wallet-signed TradeOrder create from a bound quote.
Request
POST /api/v1/orders/prepare
Authentication is required. Supported credentials: a customer API key with trade scope in X-API-Key or a signed-in customer session token in Authorization: Bearer …. Send one credential type only; never both. API-key requests also require the Ed25519 headers described in request signing, and the key must be authorized for the selected Party.
Parameters
| Name | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
Idempotency-Key | header | string | Yes | min length: 8; max length: 256; pattern: ^[A-Za-z0-9._:-]+$ | — |
X-Service-Act-As | header | string | No | min length: 3; max length: 512 | Service-principal path only (local and devnet stages; refused by configuration on mainnet). With an OAuth client-credentials bearer token from the validator, names the allow-listed Party the client acts as. Missing: 400 SERVICE_ACT_AS_REQUIRED; not allow-listed: 403 SERVICE_PARTY_NOT_ALLOWED. Ignored for customer session tokens. |
X-API-Timestamp | header | string | No | pattern: ^[0-9]{13}$ | Required with X-API-Key on trade operations: Unix time in milliseconds (13 digits), at most 1 s ahead of the server and no older than the receive window. |
X-API-Recv-Window | header | string | No | pattern: ^[0-9]{1,5}$ | Optional with X-API-Key on trade operations: signature validity window in milliseconds (default 5000, maximum 60000). It is part of the signed string. |
X-API-Signature | header | string | No | pattern: ^[A-Za-z0-9_-]{86}$ | Required with X-API-Key on trade operations: Ed25519 signature, unpadded base64url (86 characters), of the canonical string (see the apiKey security scheme). |
X-Request-Id | header | string | No | min length: 8; max length: 128; pattern: ^[A-Za-z0-9._:-]+$ | Optional client correlation identifier. The server always generates a separate authoritative request ID and retains a valid supplied value only as secondary audit correlation metadata. |
Request body
A body is required.
Content type: application/json
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
quoteId | string | Yes | format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ | — |
walletConnectionId | string | Yes | format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ | — |
Additional fields are not allowed.
Send a signed request
Use the signed POST helper with this exact API path and the body declared above. It serializes and signs the same bytes it sends. Preserve the idempotency key and payload for a retry; create a fresh timestamp and signature.
A raw unsigned API-key request will be rejected. For the distinction between a request signature and a ledger signature, read the order flow.
Responses
201
The create command for sendTransaction.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
commandId | string | Yes | min length: 1; max length: 255 | — |
clientRef | string | Yes | min length: 1; max length: 255 | — |
operationId | string | Yes | format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ | — |
partyId | string | Yes | min length: 1 | — |
expiresAt | string | Yes | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
instrumentId | string | Yes | min length: 1; max length: 160 | — |
side | string | Yes | allowed: "buy", "sell" | — |
venue | string | Yes | allowed: "curve", "amm" | — |
amount | string | Yes | — | — |
limit | string | Yes | — | — |
expectedOutput | string | Yes | — | — |
quote | object · Schema 1 | Yes | — | — |
actAs | array of string · Schema 2 | Yes | min items: 1; max items: 1 | — |
commands | array of object · Schema 3 | Yes | min items: 1; max items: 1 | — |
disclosedContracts | array of object · Schema 4 | Yes | max items: 0 | — |
packageIdSelectionPreference | array of string · Schema 5 | Yes | max items: 4 | — |
Additional fields are not allowed.
400
Malformed body or missing Idempotency-Key. Also: VALIDATION_FAILED, IDEMPOTENCY_KEY_REQUIRED, AMBIGUOUS_CREDENTIALS, SERVICE_ACT_AS_REQUIRED.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
401
Credentials are missing, malformed, expired or revoked. Codes: AUTHENTICATION_REQUIRED, INVALID_AUTHORIZATION_HEADER, INVALID_ACCESS_TOKEN, SESSION_REVOKED, API_KEY_INVALID, API_KEY_REVOKED, API_KEY_SIGNATURE_INVALID, API_KEY_TIMESTAMP_OUT_OF_WINDOW.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
403
Wallet not owned, or the Party is not allowed. Also: ACCOUNT_RESTRICTED, ANONYMOUS_ACCOUNT_NOT_ALLOWED, API_KEY_ROUTE_NOT_ALLOWED, SERVICE_PARTY_NOT_ALLOWED, SERVICE_PRINCIPAL_NOT_ALLOWED, SIGNUP_NOT_INVITED, API_KEY_IP_NOT_ALLOWED, PRODUCT_ACCOUNT_RESTRICTED, API_KEY_SCOPE_REQUIRED, API_KEY_PARTY_NOT_AUTHORIZED.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
404
Unknown quote, or no live pool for the token.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
409
Quote/wallet mismatch, reused key, or a paused pool. Also: IDEMPOTENCY_KEY_CONFLICT, IDEMPOTENCY_CONFLICT.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
413
The request body exceeds the size limit.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
422
The pool cannot take this order.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
428
The signed-in account must accept the current product terms first. Codes: PRODUCT_LEGAL_ACCEPTANCE_REQUIRED.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
429
The caller exceeded an IP or principal request budget.
| Header | Type | Description |
|---|---|---|
Retry-After | integer | Whole seconds to wait before retrying a rate-limited request. |
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
503
The ledger or database is unavailable. Also: AUTHENTICATION_UNAVAILABLE, AUTHORIZATION_UNAVAILABLE.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
default
Machine-readable API error. The HTTP status identifies the error class.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
Nested schemas
Field links above lead to the complete nested object, array, and variant definitions below. Required fields are scoped to their containing object.
Schema 1
Response 201.quote
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
authority | object · Schema 6 | Yes | — | — |
buyAmount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
buyInstrument | object · Schema 7 | Yes | — | — |
creatorRevenueAllocations | array of object · Schema 8 | Yes | min items: 1; max items: 1 | — |
display | object · Schema 9 | Yes | — | — |
economics | object · Schema 10 | Yes | — | — |
execution | "simulated" | Yes | — | — |
expiresAt | string | Yes | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
fee | object · Schema 11 | Yes | — | — |
feeCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
feeConfig | object · Schema 12 | Yes | — | — |
feeLineItems | array of object · Schema 13 | Yes | min items: 1; max items: 1 | — |
issuedAt | string | Yes | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
makerFeeCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
minimumBuyAmount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
networkId | string | Yes | pattern: ^canton:[-_a-zA-Z0-9]{1,32}$ | — |
notionalCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
platformFeeCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
referralFeeCc | string | No | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
pricingModel | "preview-simulation-v2" | Yes | — | — |
pricingSource | object · Schema 14 | Yes | — | — |
quoteId | string | Yes | format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ | — |
route | array of object · Schema 15 | Yes | min items: 1; max items: 1 | — |
sellAmount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
sellInstrument | object · Schema 7 | Yes | — | — |
settlement | object · Schema 16 | Yes | — | — |
slippageBps | integer | Yes | minimum: 1; maximum: 5000 | — |
totalSupply | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
wallet | object · Schema 17 | Yes | — | — |
allowPartialFill | boolean | No | — | — |
fill | string | No | allowed: "full", "partial" | — |
grossCcUsed | one or more variants · Schema 18 | No | — | — |
unspentCc | string | No | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
graduates | boolean | No | — | — |
limitTokenOut | string | No | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
Additional fields are not allowed.
Schema 2
Response 201.actAs
Type: array of string.
min items: 1; max items: 1
Array items: string. min length: 1
Schema 3
Response 201.commands
Type: array of object.
min items: 1; max items: 1
Array items: object · Schema 19.
Schema 4
Response 201.disclosedContracts
Type: array of object.
max items: 0
Array items: object · Schema 19.
Schema 5
Response 201.packageIdSelectionPreference
Type: array of string.
max items: 4
Array items: string. pattern: ^[0-9a-f]{64}$
Schema 6
Response 201.quote.authority
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
expiresAt | string | Yes | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
legs | array of exactly one variant · Schema 20 | Yes | min items: 1; max items: 1 | — |
networkId | string | Yes | pattern: ^canton:[-_a-zA-Z0-9]{1,32}$ | — |
policy | object · Schema 21 | Yes | — | — |
replay | object · Schema 22 | Yes | — | — |
synchronizerId | string | Yes | min length: 1; max length: 160 | — |
Additional fields are not allowed.
Schema 7
Response 201.quote.buyInstrument
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
admin | string | Yes | min length: 1; max length: 160 | — |
id | string | Yes | min length: 1; max length: 160 | — |
Additional fields are not allowed.
Schema 8
Response 201.quote.creatorRevenueAllocations
Type: array of object.
min items: 1; max items: 1
Array items: object · Schema 23.
Schema 9
Response 201.quote.display
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
averagePriceCcPerToken | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ | — |
graduationPercentAfter | one or more variants · Schema 24 | Yes | — | — |
kind | "display-only" | Yes | — | — |
priceAfterCcPerToken | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ | — |
priceAfterPerMillionTokensCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ | — |
priceBeforeCcPerToken | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ | — |
priceBeforePerMillionTokensCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ | — |
priceImpactBps | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ | — |
pricePerMillionTokensCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ | — |
rate | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ | — |
significantDigits | 12 | Yes | — | — |
Additional fields are not allowed.
Schema 10
Response 201.quote.economics
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
curveAllocationBps | integer | Yes | minimum: 5001; maximum: 9999 | — |
graduationNetCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
maxFeeBps | integer | Yes | minimum: 0; maximum: 5000 | — |
minFeeClaimCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
Additional fields are not allowed.
Schema 11
Response 201.quote.fee
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
amount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
asset | object · Schema 7 | Yes | — | — |
policy | "ledger-pool-fee-config" | Yes | — | — |
Additional fields are not allowed.
Schema 12
Response 201.quote.feeConfig
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
feeBps | integer | Yes | minimum: 0; maximum: 10000 | — |
platformShareBps | integer | Yes | minimum: 0; maximum: 10000 | — |
Additional fields are not allowed.
Schema 13
Response 201.quote.feeLineItems
Type: array of object.
min items: 1; max items: 1
Array items: object · Schema 25.
Schema 14
Response 201.quote.pricingSource
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
asOf | string | Yes | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
dataMode | "projected" | Yes | — | — |
label | "canton-ledger-acs" | Yes | — | — |
Additional fields are not allowed.
Schema 15
Response 201.quote.route
Type: array of object.
min items: 1; max items: 1
Array items: object · Schema 26.
Schema 16
Response 201.quote.settlement
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
deadline | string | Yes | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
mode | "atomic-dvp" | Yes | — | — |
readiness | "ready" | Yes | — | — |
Additional fields are not allowed.
Schema 17
Response 201.quote.wallet
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
connectionId | string | Yes | format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ | — |
partyId | string | Yes | min length: 1; max length: 512 | — |
Additional fields are not allowed.
Schema 18
Response 201.quote.grossCcUsed
Type: one or more variants.
At least one of these variants must match:
- Variant 1: string. pattern:
^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ - Variant 2: null.
Schema 19
Response 201.commands item
Type: object.
Additional field values: any value.
Schema 20
Response 201.quote.authority.legs
Type: array of exactly one variant.
min items: 1; max items: 1
Array items: exactly one variant · Schema 27.
Schema 21
Response 201.quote.authority.policy
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
hash | "sha256:453dec0f4f64164e6c89bd4fcf9303eafeadd133ca9e119acc5fd6fa694957c2" | Yes | — | — |
snapshot | any value | Yes | — | — |
version | "4" | Yes | — | — |
Additional fields are not allowed.
Schema 22
Response 201.quote.authority.replay
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
digest | string | Yes | pattern: ^sha256:[0-9a-f]{64}$ | — |
domain | "supanova.swap.quote.v2" | Yes | — | — |
Additional fields are not allowed.
Schema 23
Response 201.quote.creatorRevenueAllocations item
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
basisAmountCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
creatorRevenueCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
eligibility | "eligible" | Yes | — | — |
grossRevenueCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
launchId | string | Yes | min length: 1; max length: 160 | — |
marketReference | string | Yes | min length: 1; max length: 160 | — |
policy | object · Schema 28 | Yes | — | — |
protocolRevenueCc | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
protocolRootId | string | Yes | min length: 1; max length: 160 | — |
routeLegCount | 1 | Yes | — | — |
routeLegIndex | 0 | Yes | — | — |
source | string | Yes | allowed: "curve-trading-fee", "amm-trading-fee" | — |
tokenInstrument | object · Schema 7 | Yes | — | — |
Additional fields are not allowed.
Schema 24
Response 201.quote.display.graduationPercentAfter
Type: one or more variants.
At least one of these variants must match:
- Variant 1: string. pattern:
^(?:0|[1-9]\d{0,27})(?:\.\d{1,40})?$ - Variant 2: null.
Schema 25
Response 201.quote.feeLineItems item
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
amount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
instrument | object · Schema 7 | Yes | — | — |
kind | "trading" | Yes | — | — |
label | string | Yes | min length: 1; max length: 120 | — |
Additional fields are not allowed.
Schema 26
Response 201.quote.route item
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
payInstrument | object · Schema 7 | Yes | — | — |
receiveInstrument | object · Schema 7 | Yes | — | — |
venue | string | Yes | allowed: "canton-dex", "launch-curve" | — |
Additional fields are not allowed.
Schema 27
Response 201.quote.authority.legs item
Type: exactly one variant.
Exactly one of these variants must match:
Schema 28
Response 201.quote.creatorRevenueAllocations item.policy
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
hash | "sha256:21c68b457e7684149d484e6bfb378457c36ea188e01187500367a76bf29cbde6" | Yes | — | — |
id | "supanova-creator-revenue-policy" | Yes | — | — |
version | "2" | Yes | — | — |
Additional fields are not allowed.
Schema 29
Response 201.quote.authority.legs item variant 1
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
creatorRevenue | object · Schema 31 | Yes | — | — |
lifecycleEpoch | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
market | object · Schema 32 | Yes | — | — |
marketReference | string | Yes | min length: 1; max length: 160 | — |
marketRevision | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
nextMarketRevision | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
payInstrument | object · Schema 7 | Yes | — | — |
receiveInstrument | object · Schema 7 | Yes | — | — |
securityEpoch | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
after | object · Schema 33 | Yes | — | — |
before | object · Schema 33 | Yes | — | — |
formulaId | "supanova-virtual-cpmm-v1" | Yes | — | — |
kind | "virtual-cpmm" | Yes | — | — |
lifecycleStage | string | Yes | allowed: "ignition", "near_escape" | — |
limits | object · Schema 34 | Yes | — | — |
Additional fields are not allowed.
Schema 30
Response 201.quote.authority.legs item variant 2
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
creatorRevenue | object · Schema 31 | Yes | — | — |
lifecycleEpoch | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
market | object · Schema 32 | Yes | — | — |
marketReference | string | Yes | min length: 1; max length: 160 | — |
marketRevision | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
nextMarketRevision | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
payInstrument | object · Schema 7 | Yes | — | — |
receiveInstrument | object · Schema 7 | Yes | — | — |
securityEpoch | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
after | object · Schema 35 | Yes | — | — |
before | object · Schema 35 | Yes | — | — |
formulaId | "supanova-real-cpmm-v1" | Yes | — | — |
kind | "real-cpmm" | Yes | — | — |
lifecycleStage | "in_orbit" | Yes | — | — |
limits | object · Schema 36 | Yes | — | — |
Additional fields are not allowed.
Schema 31
Response 201.quote.authority.legs item variant 1.creatorRevenue
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
eligibility | "eligible" | Yes | — | — |
launchId | string | Yes | min length: 1; max length: 160 | — |
policy | object · Schema 28 | Yes | — | — |
protocolRootId | string | Yes | min length: 1; max length: 160 | — |
Additional fields are not allowed.
Schema 32
Response 201.quote.authority.legs item variant 1.market
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
economics | object · Schema 10 | Yes | — | — |
feeConfig | object · Schema 12 | Yes | — | — |
totalSupply | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
Additional fields are not allowed.
Schema 33
Response 201.quote.authority.legs item variant 1.after
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
graduated | boolean | Yes | — | — |
netCcReserve | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
tokensRemaining | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
tokensSold | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
Additional fields are not allowed.
Schema 34
Response 201.quote.authority.legs item variant 1.limits
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
exactFinalGrossCc | one or more variants · Schema 18 | Yes | — | — |
inputAsset | string | Yes | allowed: "cc", "token" | — |
maximumInputAmount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
recovery | string | Yes | allowed: "exact-final-gross-or-smaller-buy", "sell-all-or-leave-at-least-minimum" | — |
Additional fields are not allowed.
Schema 35
Response 201.quote.authority.legs item variant 2.after
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
anchor | string | Yes | allowed: "cc-reserve", "initial", "token-reserve" | — |
ccReserve | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
revision | string | Yes | pattern: ^(?:0|[1-9]\d{0,18})$ | — |
tokenReserve | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
Additional fields are not allowed.
Schema 36
Response 201.quote.authority.legs item variant 2.limits
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
exactFinalGrossCc | null | Yes | — | — |
inputAsset | string | Yes | allowed: "cc", "token" | — |
maximumInputAmount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
recovery | "refresh-on-revision-change" | Yes | — | — |
Additional fields are not allowed.
Source contract
This page is generated from the checked-in customer OpenAPI snapshot. Download JSON, download YAML, or compare the live API reference. Snapshot provenance records the retrieval date and checksum.