Assets

Instruments, trading pairs, prices, and balances

Assets Domain

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

Key Entities

Instrument

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

FieldDescription
idUUID (use this in API calls)
symbolTrading symbol (BTC, CHF, ETH)
typeAsset classification
decimalsPrecision for quantities

Instrument Types

CategoryTypes
FiatCURRENCY
CryptoCRYPTO_CURRENCY
SecuritiesSTOCK, DEBT, FUND_SHARES, ASSET
OtherCOMMODITY, NFT, UTILITY_TOKEN

Pair

A trading relationship between two instruments.

FieldDescription
idUUID (use this in orders)
symbolTrading symbol (BTC/CHF)
base_idBase instrument UUID
quote_idQuote instrument UUID
statusOPEN, SUSPENDED, CLOSED

Price

Current market price for a pair.

FieldDescription
bidBest buy price
askBest sell price
lastLast traded price
volume_24h24-hour volume

Balance

Asset holdings in a sub-account.

FieldDescription
idBalance UUID
instrumentIdInstrument UUID
subAccountIdSub-account UUID
availableAvailable for trading
ordersReservedLocked in open orders
withdrawalsReservedLocked for pending withdrawals
creditAmount owed by the sub-account
exposureOverdraftExposure overdraft amount
exposureReservedReserved 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

EndpointMethodDescription
/instrumentsGETList all instruments
/instruments/{id}GETInstrument details

Pairs

EndpointMethodDescription
/pairsGETList all pairs
/pairs/{id}GETPair details

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

Prices

EndpointMethodDescription
/pricesGETAll pair prices

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

Balances

EndpointMethodDescription
/balances/by-sub-account/{subAccountId}GETAll balances for sub-account
/balances/by-sub-account/{subAccountId}/{id}GETSingle balance by ID
/balances/by-sub-account/{subAccountId}/{balanceId}/historyGETBalance history
/balances/by-sub-account/{subAccountId}/histaggGETHistorical 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

TopicDescription
*@prices@{category}Price updates (e.g., *@prices@auction)
{pair}@depth@{speed}Order book updates (e.g., BTC/CHF@depth@1000ms)
{subAccountId}@balancesBalance changes

Related




  © 2025 Taurus SA. All rights reserved.