Read the authenticated user’s wallet portfolio projection.
GET /api/v1/wallet/portfolio. Read the authenticated user’s wallet portfolio projection.
Request
GET /api/v1/wallet/portfolio
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
| Name | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
walletConnectionId | query | string | No | 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)$ | — |
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-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. |
cURL
curl --fail-with-body --silent --show-error \
--request GET \
--url "https://launch-api.supanova.app/api/v1/wallet/portfolio" \
--header "X-API-Key: $SUPANOVA_API_KEY"Responses
200
The owned wallet portfolio read model.
| 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 |
|---|---|---|---|---|
asOf | string | Yes | — | — |
balances | array of object · Schema 1 | Yes | — | — |
dataMode | string | Yes | allowed: "projected", "simulated" | — |
disclaimer | string | Yes | — | — |
networkId | string | Yes | pattern: ^canton:[-_a-zA-Z0-9]{1,32}$ | — |
partyId | string | Yes | — | — |
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.
400
The request is malformed or failed validation. Codes: VALIDATION_FAILED, 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.
| 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
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.
| 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
A dependency is unavailable or the feature is not enabled on this deployment. Codes: 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 200.balances
Type: array of object.
Array items: object · Schema 2.
Schema 2
Response 200.balances item
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
actions | object · Schema 3 | Yes | — | — |
asset | object · Schema 4 | Yes | — | — |
availableAmount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
depositAccount | object · Schema 5 | No | — | — |
instrumentId | object · Schema 6 | Yes | — | — |
lockedAmount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
name | string | Yes | — | — |
publicHolderHints | array of string · Schema 7 | No | max items: 4 | — |
symbol | string | Yes | — | — |
totalAmount | string | Yes | pattern: ^(?:0|[1-9]\d{0,27})(?:\.\d{1,10})?$ | — |
Additional fields are not allowed.
Schema 3
Response 200.balances item.actions
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
swapBuy | object · Schema 8 | Yes | — | — |
swapSell | object · Schema 8 | Yes | — | — |
transfer | object · Schema 8 | Yes | — | — |
Additional fields are not allowed.
Schema 4
Response 200.balances item.asset
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
assetType | string | Yes | allowed: "native", "stablecoin", "utility", "governance", "security", "other" | — |
canonicalSlug | string | Yes | min length: 3; max length: 64; pattern: ^[a-z0-9][a-z0-9-]{1,62}[a-z0-9]$ | — |
decimals | integer | Yes | minimum: 0; maximum: 18 | — |
logoPath | one or more variants · Schema 9 | Yes | — | — |
marketSlug | one or more variants · Schema 10 | Yes | — | — |
Additional fields are not allowed.
Schema 5
Response 200.balances item.depositAccount
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
frozen | boolean | Yes | — | — |
walletCcAmount | one or more variants · Schema 11 | Yes | — | — |
walletCcUnavailableReason | one or more variants · Schema 12 | Yes | — | — |
Additional fields are not allowed.
Schema 6
Response 200.balances item.instrumentId
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
admin | string | Yes | min length: 1; max length: 512 | — |
id | string | Yes | min length: 1; max length: 512 | — |
Additional fields are not allowed.
Schema 7
Response 200.balances item.publicHolderHints
Type: array of string.
max items: 4
Array items: string. pattern: ^holder_[0-9a-f]{24}$
Schema 8
Response 200.balances item.actions.swapBuy
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
dataMode | string | Yes | allowed: "none", "projected", "simulated" | — |
reasonCode | one or more variants · Schema 13 | Yes | — | — |
status | string | Yes | allowed: "blocked", "disabled", "preview", "ready" | — |
Additional fields are not allowed.
Schema 9
Response 200.balances item.asset.logoPath
Type: one or more variants.
At least one of these variants must match:
- Variant 1: string. min length:
1; max length:512 - Variant 2: null.
Schema 10
Response 200.balances item.asset.marketSlug
Type: one or more variants.
At least one of these variants must match:
- Variant 1: string. min length:
3; max length:64; pattern:^[a-z0-9][a-z0-9-]{1,62}[a-z0-9]$ - Variant 2: null.
Schema 11
Response 200.balances item.depositAccount.walletCcAmount
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.balances item.depositAccount.walletCcUnavailableReason
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 13
Response 200.balances item.actions.swapBuy.reasonCode
Type: one or more variants.
At least one of these variants must match:
- Variant 1: string. min length:
1; max length:128 - 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.