supanovasupanovaDOCS
Open Launchpad
Launchpad documentation
wallet

Value the connected account in USD: wallet CC, trading balance and token holdings, with rate source, completeness and in-flight funds.

GET /api/v1/wallet/valuation. Value the connected account in USD: wallet CC, trading balance and token holdings, with rate source, completeness and in-flight funds.

Request

GET /api/v1/wallet/valuation

Authentication is required. Supported credentials: a customer API key with read scope in X-API-Key or a signed-in customer session token in Authorization: Bearer …. Send one credential type only; never both.

Parameters

NameInTypeRequiredConstraintsDescription
walletConnectionIdquerystringNoformat: 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)$—
X-Service-Act-AsheaderstringNomin length: 3; max length: 512Service-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-Request-IdheaderstringNomin 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.

cURL

bash
curl --fail-with-body --silent --show-error \
  --request GET \
  --url "https://launch-api.supanova.app/api/v1/wallet/valuation" \
  --header "X-API-Key: $SUPANOVA_API_KEY"

Responses

200

The account valuation.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Type: object.

FieldTypeRequiredConstraintsDescription
asOfstringYesformat: 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)))$When this valuation was composed.
currency"USD"Yes——
fxone or more variants · Schema 1Yes——
holdingsarray of object · Schema 2Yesmax items: 500—
inTransitobject · Schema 3Yes—Deposits and withdrawals in flight. Never added to the total: their CC may already have left one place and not reached the other.
networkIdstringYespattern: ^canton:[-_a-zA-Z0-9]{1,32}$—
partyIdstringYes——
sourcesobject · Schema 4Yes——
totalobject · Schema 5Yes——
tradingBalanceobject · Schema 6Yes—Spendable launchpad deposit balance.
walletCcobject · Schema 7Yes—The owner's on-chain CC (Amulet).
walletConnectionIdstringYesformat: 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.

400

The request is malformed or failed validation. Codes: VALIDATION_FAILED, AMBIGUOUS_CREDENTIALS, SERVICE_ACT_AS_REQUIRED.

HeaderTypeDescription
X-Request-IdstringServer-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.

HeaderTypeDescription
X-Request-IdstringServer-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

The credential may not call this route. Owner routes accept only a customer API key: an internal master key answers API_KEY_ROUTE_NOT_ALLOWED. Codes: 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.

HeaderTypeDescription
X-Request-IdstringServer-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

No verified wallet connection exists.

HeaderTypeDescription
X-Request-IdstringServer-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

The reads resolved different wallet connections.

HeaderTypeDescription
X-Request-IdstringServer-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.

HeaderTypeDescription
Retry-AfterintegerWhole seconds to wait before retrying a rate-limited request.
X-Request-IdstringServer-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

Not a ledger-backed environment. Also: AUTHENTICATION_UNAVAILABLE, AUTHORIZATION_UNAVAILABLE.

HeaderTypeDescription
X-Request-IdstringServer-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.

HeaderTypeDescription
X-Request-IdstringServer-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 200.fx

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: object · Schema 8.
  • Variant 2: null.

Schema 2

Response 200.holdings

Type: array of object.

max items: 500

Array items: object · Schema 9.

Schema 3

Response 200.inTransit

Type: object.

Deposits and withdrawals in flight. Never added to the total: their CC may already have left one place and not reached the other.

FieldTypeRequiredConstraintsDescription
countedInTotalfalseYes——
depositsCcstringYespattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$—
pendingDepositsintegerYesminimum: 0; maximum: 9007199254740991—
pendingWithdrawalsintegerYesminimum: 0; maximum: 9007199254740991—
withdrawalsCcstringYespattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$—

Additional fields are not allowed.

Schema 4

Response 200.sources

Type: object.

FieldTypeRequiredConstraintsDescription
balancesAsOfstringYesformat: 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)))$Ledger read time of wallet CC and the trading balance.
holdingsAsOfstringYesformat: 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)))$PQS read time of the token holdings.

Additional fields are not allowed.

Schema 5

Response 200.total

Type: object.

FieldTypeRequiredConstraintsDescription
completebooleanYes——
gapsarray of string · Schema 10Yesmax items: 5—
knownValueCcstringYespattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$Sum of the components that are known; a lower bound when incomplete.
knownValueUsdone or more variants · Schema 11Yes——
valueCcone or more variants · Schema 12Yes—Null unless every CC component is known and nothing is in transit (a missing rate does not null it).
valueUsdone or more variants · Schema 13Yes—Null unless complete.

Additional fields are not allowed.

Schema 6

Response 200.tradingBalance

Type: object.

Spendable launchpad deposit balance.

FieldTypeRequiredConstraintsDescription
amountCcone or more variants · Schema 14Yes—Null: unknown, not zero.
valueUsdone or more variants · Schema 11Yes——
frozenbooleanYes——

Additional fields are not allowed.

Schema 7

Response 200.walletCc

Type: object.

The owner's on-chain CC (Amulet).

FieldTypeRequiredConstraintsDescription
amountCcone or more variants · Schema 14Yes—Null: unknown, not zero.
valueUsdone or more variants · Schema 11Yes——
unavailableReasonone or more variants · Schema 15Yes——

Additional fields are not allowed.

Schema 8

Response 200.fx variant 1

Type: object.

FieldTypeRequiredConstraintsDescription
effectiveAtone or more variants · Schema 16Yes—The round's opensAt; null when this backend has not recorded the round.
observedAtstringYesformat: 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)))$When this backend fetched the rate.
rateUsdPerCcstringYespattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$—
roundNumberintegerYesminimum: 0; maximum: 9007199254740991—
source"splice-open-mining-round"Yes—Splice super validators amuletPrice; a validator reference, not a traded price.
sourceDetailstringYesmin length: 1; max length: 100—
stalebooleanYes——

Additional fields are not allowed.

Schema 9

Response 200.holdings item

Type: object.

FieldTypeRequiredConstraintsDescription
amountstringYespattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$Total held: available plus locked.
instrumentIdobject · Schema 17Yes——
marketSlugone or more variants · Schema 15Yes——
priceBasis"marginal-price"Yes—Current marginal price; not what selling the whole position would return.
priceCcone or more variants · Schema 18Yes——
symbolstringYes——
valueCcone or more variants · Schema 11Yes——
valueUsdone or more variants · Schema 11Yes——

Additional fields are not allowed.

Schema 10

Response 200.total.gaps

Type: array of string.

max items: 5

Array items: string. allowed: "wallet-cc-unknown", "unpriced-holding", "funds-in-transit", "rate-unavailable", "rate-stale"

Schema 11

Response 200.total.knownValueUsd

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 12

Response 200.total.valueCc

Type: one or more variants.

Null unless every CC component is known and nothing is in transit (a missing rate does not null it).

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 13

Response 200.total.valueUsd

Type: one or more variants.

Null unless complete.

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 14

Response 200.tradingBalance.amountCc

Type: one or more variants.

Null: unknown, not zero.

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 15

Response 200.walletCc.unavailableReason

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. min length: 1; max length: 64
  • Variant 2: null.

Schema 16

Response 200.fx variant 1.effectiveAt

Type: one or more variants.

The round's opensAt; null when this backend has not recorded the round.

At least one of these variants must match:

  • Variant 1: string. 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)))$
  • Variant 2: null.

Schema 17

Response 200.holdings item.instrumentId

Type: object.

FieldTypeRequiredConstraintsDescription
adminstringYesmin length: 1; max length: 512—
idstringYesmin length: 1; max length: 512—

Additional fields are not allowed.

Schema 18

Response 200.holdings item.priceCc

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.

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.

Generated from the public API contractDeveloper settings