Vortum SDK

The official TypeScript SDK for building on the Vortum trading platform.

Features

• Type-Safe — Full TypeScript support with comprehensive type definitions
• Multiple Auth Methods — Internet Identity, NFID, OISY, Solana wallets, Bitcoin wallets
• Complete API — Trading, wallet, market data, and account management
• ICP Native — Built for Internet Computer canisters

Quick Example

import { VortumClient } from '@vortum/sdk'

// Create client
const client = await VortumClient.create()

// Authenticate with Internet Identity
await client.auth.loginWithII()

// Place an order
const order = await client.trading.placeOrder({
  marketId: 'BTC_USDC',
  side: 'Bid',
  orderType: { Limit: { price: 50000_00000000n } },
  quantity: 1_00000000n,
  timeInForce: 'GTC',
})

// Get balances
const balances = await client.wallet.getBalances()

Sections

• Installation — Install and configure the SDK
• Authentication — II, NFID, OISY, Solana, and Bitcoin wallets
• Trading — Place orders and manage trades
• Market Data — Orderbooks, prices, and trade history
• Wallet — Deposits, withdrawals, and balances