# OBSDN

> Perpetual exchange with off-chain matching and on-chain settlement. REST + WebSocket API.

Append `.md` to any page URL to get raw markdown. Example: /api-ref/orders/placeOrder.md

## Guides
- [Getting Started](/api-ref/guides/getting-started.md): Integration flow, environments, authentication
- [Authentication](/api-ref/guides/authentication.md): API keys, HMAC signing, EIP-712
- [Signing](/api-ref/guides/signing.md): EIP-712 typed data signing for orders/transfers
- [Orders Guide](/api-ref/guides/orders.md): Order types, lifecycle, execution policies
- [WebSocket Guide](/api-ref/guides/websocket.md): Connection, channels, subscriptions
- [Error Handling](/api-ref/guides/error-handling.md): Error codes, rate limits
- [SDKs](/api-ref/guides/sdks.md): Python and Rust SDK links
- [Data Center](/api-ref/guides/data-center.md): Colocation, latency optimization

## REST API - Auth
- [Register Signer](/api-ref/auth/registerSigner.md): Register wallet + signer, get API key
- [Create API Key](/api-ref/auth/createAPIKey.md): Generate additional API keys
- [List API Keys](/api-ref/auth/getAPIKeys.md): List active API keys
- [Delete API Keys](/api-ref/auth/deleteAPIKeys.md): Revoke API keys

## REST API - Markets
- [List Markets](/api-ref/markets/getMarkets.md): All markets with mark price, funding, specs
- [Order Book](/api-ref/markets/getOrderBook.md): Depth snapshot for a market
- [Candles](/api-ref/markets/getMarketCandles.md): OHLCV candle data
- [Market Trades](/api-ref/markets/getMarketTrades.md): Recent trades
- [Account Trade History](/api-ref/markets/getAccountTradeHistory.md): User's trade history
- [Funding Rate History](/api-ref/markets/getFundingRateHistory.md): Historical funding rates

## REST API - Orders
- [Place Order](/api-ref/orders/placeOrder.md): Create order with EIP-712 signature
- [Place Order Group](/api-ref/orders/placeOrderGroup.md): Atomic multi-order placement
- [Place TWAP Orders](/api-ref/orders/placeTWAPOrders.md): Time-weighted average price orders
- [Cancel Order](/api-ref/orders/cancelOrder.md): Cancel by order ID
- [Cancel by Client ID](/api-ref/orders/cancelOrderByClientId.md): Cancel by client order ID
- [Cancel Multiple](/api-ref/orders/cancelOrders.md): Batch cancel
- [Cancel All](/api-ref/orders/cancelAllOrders.md): Cancel all open orders
- [Get Order](/api-ref/orders/getOrder.md): Order details by ID
- [Get by Client ID](/api-ref/orders/getOrderByClientId.md): Order details by client ID
- [List Open Orders](/api-ref/orders/listOpenOrders.md): All open orders
- [Order History](/api-ref/orders/listOrderHistory.md): Historical orders

## REST API - Portfolio
- [Get Portfolio](/api-ref/portfolios/getPortfolio.md): Collateral, positions, margin
- [Portfolio History](/api-ref/portfolios/getPortfolioHistory.md): Historical snapshots
- [PnL History](/api-ref/portfolios/getPnLHistory.md): Profit and loss over time
- [Position History](/api-ref/portfolios/getPositionHistory.md): Position changes
- [Funding Payments](/api-ref/portfolios/getFundingPayments.md): Funding fee history
- [Set Leverage](/api-ref/portfolios/setLeverage.md): Change leverage per market
- [Set Margin Mode](/api-ref/portfolios/setMarginMode.md): Cross or isolated margin
- [Transfer Margin](/api-ref/portfolios/transferMargin.md): Move margin between positions
- [Trading Calendar](/api-ref/portfolios/getTradingCalendar.md): Market trading hours

## REST API - Transfers
- [Send Funds](/api-ref/transfers/sendFunds.md): Transfer between accounts
- [Withdraw](/api-ref/transfers/withdrawCollateral.md): Withdraw to wallet
- [Transfer History](/api-ref/transfers/getTransferHistory.md): Past transfers
- [Withdrawal Requests](/api-ref/transfers/getWithdrawalRequests.md): Pending withdrawals

## REST API - Other
- [Get Account](/api-ref/accounts/getAccount.md): Account details
- [Get Assets](/api-ref/assets/getAssets.md): Supported collateral assets
- [Chain Config](/api-ref/chain/getChainConfig.md): Contract addresses, chain ID
- [Get Prices](/api-ref/prices/getPrices.md): Oracle prices
- [Client Info](/api-ref/general/getClientInfo.md): Server info
- [Error Codes](/api-ref/general/getErrorCodes.md): All error codes

## REST API - Subaccounts
- [Create Subaccount](/api-ref/subaccounts/createSubaccount.md): Create sub-account
- [Delete Subaccount](/api-ref/subaccounts/deleteSubaccount.md): Remove sub-account
- [Subaccount Portfolio](/api-ref/subaccounts/getSubaccountPortfolio.md): Sub-account positions
- [Subaccount Collateral](/api-ref/subaccounts/getSubaccountCollateral.md): Sub-account balances
- [Subaccount History](/api-ref/subaccounts/getSubaccountPortfolioHistory.md): Historical snapshots
- [Freeze Subaccount](/api-ref/subaccounts/setSubaccountFrozen.md): Freeze/unfreeze

## WebSocket
- [Overview](/api-ref/websocket/overview.md): Connection, auth, message format
- [Channels](/api-ref/websocket/channels.md): Available channels and subscription
- [Order Book](/api-ref/websocket/book.md): Depth snapshots and deltas
- [Ticker](/api-ref/websocket/ticker.md): Market summary updates
- [Trades](/api-ref/websocket/trade.md): Real-time trade stream
- [Candles](/api-ref/websocket/candle.md): Live candle updates
- [Oracle](/api-ref/websocket/oracle.md): Oracle price feed
- [Orders](/api-ref/websocket/order.md): Private order updates
- [Positions](/api-ref/websocket/position.md): Private position updates
- [Portfolio](/api-ref/websocket/portfolio.md): Private portfolio updates
- [Notifications](/api-ref/websocket/notification.md): System notifications
- [Checksum](/api-ref/websocket/checksum.md): Book integrity verification
- [Errors](/api-ref/websocket/errors.md): WebSocket error codes

## Trading Docs
- [Fees](/fees.md): Fee tiers, maker/taker rates
- [Orders](/orders.md): Order types and execution
- [Margin System](/margin-system.md): Cross and isolated margin
- [Liquidations](/liquidations.md): Liquidation mechanics
- [Mark Price](/mark-price.md): Mark price calculation
- [Oracle Price](/oracle-price.md): Oracle price sources
- [Funding](/funding.md): Funding rate mechanism
- [PnL and Entry Price](/pnl-and-entry-price.md): PnL calculation
- [Instruments](/instruments.md): Market specifications
- [Trading Sessions](/trading-sessions.md): Market hours
- [Risk Parameters](/risk-parameters.md): Risk limits
- [ADL and Insurance Fund](/adl-and-insurance-fund.md): Auto-deleveraging
- [Corporate Actions](/corporate-actions.md): Stock split handling
- [Market Lifecycle](/market-lifecycle.md): Market states
- [Referral Program](/referral-program.md): Referral system
- [Deployed Contracts](/deployed-contracts.md): Contract addresses
- [FAQ](/faq.md): Common questions