Assets Domain

The assets domain manages instruments, trading pairs, prices, and balances.

Key Entities

Instrument

A tradable asset (cryptocurrency, fiat currency, or security).

Field	Description
`id`	UUID (use this in API calls)
`symbol`	Trading symbol (BTC, CHF, ETH)
`type`	Asset classification
`decimals`	Precision for quantities

Instrument Types

Category	Types
Fiat	`CURRENCY`
Crypto	`CRYPTO_CURRENCY`
Securities	`STOCK`, `DEBT`, `FUND_SHARES`, `ASSET`
Other	`COMMODITY`, `NFT`, `UTILITY_TOKEN`

Pair

A trading relationship between two instruments.

Field	Description
`id`	UUID (use this in orders)
`symbol`	Trading symbol (BTC/CHF)
`base_id`	Base instrument UUID
`quote_id`	Quote instrument UUID
`status`	OPEN, SUSPENDED, CLOSED

Price

Current market price for a pair.

Field	Description
`bid`	Best buy price
`ask`	Best sell price
`last`	Last traded price
`volume_24h`	24-hour volume

Balance

Asset holdings in a sub-account.

Field	Description
`id`	Balance UUID
`instrumentId`	Instrument UUID
`subAccountId`	Sub-account UUID
`available`	Available for trading
`ordersReserved`	Locked in open orders
`withdrawalsReserved`	Locked for pending withdrawals
`credit`	Amount owed by the sub-account
`exposureOverdraft`	Exposure overdraft amount
`exposureReserved`	Reserved for exposure

Data Flow

1. GET /instruments → Get instrument IDs
2. GET /pairs → Get pair IDs and constraints
3. GET /prices → Get current prices
4. Use IDs in trading/payment operations

Endpoints Overview

Instruments

Endpoint	Method	Description
`/instruments`	GET	List all instruments
`/instruments/{id}`	GET	Instrument details

Pairs

Endpoint	Method	Description
`/pairs`	GET	List all pairs
`/pairs/{id}`	GET	Pair details

Note: Order book data is available via WebSocket depth topic ({pair}@depth@{speed}), not REST API.

Prices

Endpoint	Method	Description
`/prices`	GET	All pair prices

Note: Single pair price is available via /prices with filtering or WebSocket prices topic.

Balances

Endpoint	Method	Description
`/balances/by-sub-account/{subAccountId}`	GET	All balances for sub-account
`/balances/by-sub-account/{subAccountId}/{id}`	GET	Single balance by ID
`/balances/by-sub-account/{subAccountId}/{balanceId}/history`	GET	Balance history
`/balances/by-sub-account/{subAccountId}/histagg`	GET	Historical balance aggregates

Common Patterns

Finding a Pair ID

# List all pairs
GET /pairs

# Find the pair for BTC/CHF
# Response includes: { "id": "btc-chf-uuid", "symbol": "BTC/CHF", ... }

Checking Balance Before Trade

# Get balances for sub-account
GET /balances/by-sub-account/{subAccountId}

# Filter by instrument if needed, then verify: available >= order_price * order_quantity

WebSocket Topics

Topic	Description
`*@prices@{category}`	Price updates (e.g., `*@prices@auction`)
`{pair}@depth@{speed}`	Order book updates (e.g., `BTC/CHF@depth@1000ms`)
`{subAccountId}@balances`	Balance changes