# Decibel

## Docs

- [Get account overview](https://docs.decibel.trade/api-reference/account/get-account-overview.md): Retrieve comprehensive account information including equity, realized/unrealized PnL, margin utilization, and optional performance metrics. Use `include_performance=true` to get historical return metrics.
- [Get account positions](https://docs.decibel.trade/api-reference/account/get-account-positions.md): Retrieve all open positions for a specific account with optional filtering by market. Includes position size, entry price, unrealized PnL, liquidation price, and margin details.
- [Get account's open orders](https://docs.decibel.trade/api-reference/account/get-accounts-open-orders.md): Retrieve all currently open orders for a specific account. Includes limit orders, stop orders, and TP/SL orders attached to positions. Supports pagination.
- [Get subaccounts](https://docs.decibel.trade/api-reference/account/get-subaccounts.md): Retrieve all subaccounts for a specific owner address. Returns subaccount addresses and their associated metadata.
- [Get user funding rate history](https://docs.decibel.trade/api-reference/account/get-user-funding-rate-history.md): Retrieve funding rate payment history for a specific user. Shows funding payments including the direction, amount, and associated fees. Supports filtering by market, side, and timestamp range. Supports sorting and pagination. Page size is capped at 200.
- [Get user order history](https://docs.decibel.trade/api-reference/account/get-user-order-history.md): Retrieve paginated order history for a specific user including filled, cancelled, and expired orders. Supports filtering by market, order type, status, side, reduce-only, and timestamp range. Supports sorting by timestamp (default: descending). Page size is capped at 200.
- [Get user trade history](https://docs.decibel.trade/api-reference/account/get-user-trade-history.md): Retrieve trade history for a specific user with optional filtering by market, order ID, side, and timestamp range. Returns executed trades with price, size, PnL, and fee details. Supports sorting by timestamp (default: descending) and pagination. Page size is capped at 200.
- [Get leaderboard](https://docs.decibel.trade/api-reference/analytics/get-leaderboard.md): Retrieve the trading leaderboard with rankings based on trading performance metrics. Results are paginated and can be sorted by account value, realized PnL, ROI, or trading volume. Use the `search_term` parameter to filter accounts by address prefix.
- [Get points leaderboard](https://docs.decibel.trade/api-reference/analytics/get-points-leaderboard.md): Retrieve the Hz/Amps points leaderboard with rankings by total Hz or realized PnL. Results are paginated and can be sorted by total_amps or realized_pnl. Use the `search_term` parameter to filter by owner address prefix.
- [Get portfolio chart data](https://docs.decibel.trade/api-reference/analytics/get-portfolio-chart-data.md): Returns time series data for PnL or account value over specified time range. PnL = Cumulative Realized PnL from completed trades. Account Value = Initial Deposits - Withdrawals + Realized PnL (excludes unrealized PnL).
- [Get bulk order fills](https://docs.decibel.trade/api-reference/bulk-orders/get-bulk-order-fills.md): Retrieve fills for bulk orders with optional filtering by market, sequence number, or range. Shows execution details including price, size, and timestamp for each fill.
- [Get bulk order status](https://docs.decibel.trade/api-reference/bulk-orders/get-bulk-order-status.md): Retrieve the status of a specific bulk order (placed or rejected).
- [Get bulk orders](https://docs.decibel.trade/api-reference/bulk-orders/get-bulk-orders.md): Retrieve the latest bulk orders for a specific user with optional market filtering. Returns one bulk order per market with current bid/ask levels and fills applied.
- [Get all available markets](https://docs.decibel.trade/api-reference/market-data/get-all-available-markets.md): Returns a list of all trading markets with their configuration details including leverage limits, tick sizes, decimal precision, and current market mode (Open, ReduceOnly, CloseOnly).
- [Get asset contexts](https://docs.decibel.trade/api-reference/market-data/get-asset-contexts.md): Retrieve market contexts including current prices, 24h volume, 24h price change, funding rates, and open interest for all or a specific market.
- [Get candlestick (OHLC) data](https://docs.decibel.trade/api-reference/market-data/get-candlestick-ohlc-data.md): Retrieve candlestick data for a specific market and time range. Supports intervals: 1m, 15m, 1h, 4h, 1d. Missing intervals are interpolated using the last known close price. Maximum 1000 candles per request.
- [Get market prices](https://docs.decibel.trade/api-reference/market-data/get-market-prices.md): Retrieve current prices for one or all markets, including oracle price, mark price, funding rate, and open interest. Use `market=all` or omit the parameter to fetch all markets.
- [Get trades](https://docs.decibel.trade/api-reference/market-data/get-trades.md): Retrieve recent trades for a specific market ordered by most recent first. Optionally filter by order ID to get trades for a specific order. Supports pagination.
- [Get DLP balance for a user](https://docs.decibel.trade/api-reference/predeposit-points/get-dlp-balance-for-a-user.md)
- [Get predeposit balance event history for a user](https://docs.decibel.trade/api-reference/predeposit-points/get-predeposit-balance-event-history-for-a-user.md): Retrieve paginated predeposit balance event history with optional filtering by event kind, fund type, and date range.
- [Get UA positions for a user (non-zero balances only)
Computed on-demand from predeposit_balance_events](https://docs.decibel.trade/api-reference/predeposit-points/get-ua-positions-for-a-user-non-zero-balances-onlycomputed-on-demand-from-predeposit_balance_events.md)
- [Get S0 predeposit USDC reward for a user](https://docs.decibel.trade/api-reference/predeposit-rewards/get-s0-predeposit-usdc-reward-for-a-user.md)
- [Handler to get referral info for an account (who referred them)](https://docs.decibel.trade/api-reference/referrals/handler-to-get-referral-info-for-an-account-who-referred-them.md)
- [Handler to get referrer statistics.
Non-affiliate referrers must meet the minimum trade volume threshold
to see their referral codes. Affiliate referrers always see all codes.](https://docs.decibel.trade/api-reference/referrals/handler-to-get-referrer-statisticsnon-affiliate-referrers-must-meet-the-minimum-trade-volume-thresholdto-see-their-referral-codes-affiliate-referrers-always-see-all-codes.md)
- [Handler to get users referred by a referrer](https://docs.decibel.trade/api-reference/referrals/handler-to-get-users-referred-by-a-referrer.md)
- [Authentication](https://docs.decibel.trade/api-reference/rest/authentication.md): How to authenticate REST API requests
- [Error Handling](https://docs.decibel.trade/api-reference/rest/errors.md): Common API errors and how to handle them
- [REST API Overview](https://docs.decibel.trade/api-reference/rest/overview.md): Read-only market data and user data via HTTP
- [Get active TWAP orders](https://docs.decibel.trade/api-reference/twap/get-active-twap-orders.md): Retrieve currently active TWAP (time-weighted average price) orders for a specific user. Shows orders that have remaining size to be executed.
- [Get TWAP order history](https://docs.decibel.trade/api-reference/twap/get-twap-order-history.md): Retrieve TWAP order history for a specific user including completed and cancelled orders. Returns historical TWAP orders sorted by most recent first. Supports filtering by timestamp range, sorting by timestamp, and pagination. Page size is capped at 200.
- [Get apiv1orders](https://docs.decibel.trade/api-reference/user/get-apiv1orders.md): Get single order details
- [Get delegations](https://docs.decibel.trade/api-reference/user/get-delegations.md): Retrieve active delegations for a specific subaccount. Shows delegated accounts and their associated permissions.
- [Get user fund history (deposits and withdrawals)](https://docs.decibel.trade/api-reference/user/get-user-fund-history-deposits-and-withdrawals.md): Retrieve deposit and withdrawal history for a specific user. Returns chronological list of fund movements with amounts and timestamps. Supports filtering by timestamp range, sorting by timestamp, and pagination. Page size is capped at 200.
- [Get user fund history (deprecated)](https://docs.decibel.trade/api-reference/user/get-user-fund-history-deprecated.md): **Deprecated:** This endpoint is deprecated. Please use `/api/v1/account_fund_history` instead. This endpoint is maintained for backwards compatibility only.
- [Get user positions (deprecated)](https://docs.decibel.trade/api-reference/user/get-user-positions-deprecated.md): **Deprecated:** This endpoint is deprecated. Please use `/api/v1/account_positions` instead. This endpoint is maintained for backwards compatibility only.
- [Get account-owned vaults](https://docs.decibel.trade/api-reference/vaults/get-account-owned-vaults.md): Retrieve paginated list of vaults owned by a specific account. Includes vault performance metrics, AUM, and depositor count.
- [Get account vault performance for all vaults where account has deposits](https://docs.decibel.trade/api-reference/vaults/get-account-vault-performance-for-all-vaults-where-account-has-deposits.md): Retrieve performance metrics for all vaults where the account has deposits, including net deposits, current value, returns, and PnL. Results are ordered by net deposits (descending) and support pagination.
- [Get public vaults](https://docs.decibel.trade/api-reference/vaults/get-public-vaults.md): Retrieve paginated list of public vaults with optional status, vault type, vault address, and search filtering. Use `vault_type` query parameter to filter by 'user' or 'protocol' vaults. Use `vault_address` query parameter to fetch a specific vault by its address (exact match). Use `search` query pa…
- [Get user-owned vaults (deprecated)](https://docs.decibel.trade/api-reference/vaults/get-user-owned-vaults-deprecated.md): **Deprecated:** This endpoint is deprecated. Please use `/api/v1/account_owned_vaults` instead. This endpoint is maintained for backwards compatibility only.
- [Get user vault performance (deprecated)](https://docs.decibel.trade/api-reference/vaults/get-user-vault-performance-deprecated.md): **Deprecated:** This endpoint is deprecated. Please use `/api/v1/account_vault_performance` instead. This endpoint is maintained for backwards compatibility only.
- [Connection Management](https://docs.decibel.trade/api-reference/websocket/connection.md): How to connect, authenticate, and handle WebSocket reconnection
- [WebSocket API Overview](https://docs.decibel.trade/api-reference/websocket/overview.md): Real-time market data and account updates via WebSocket
- [Account overview](https://docs.decibel.trade/api-reference/websockets/accountoverview.md): User's account overview including equity, margin, and PnL
- [All market prices](https://docs.decibel.trade/api-reference/websockets/allmarketprices.md): Price updates for all markets (global topic)
- [Bulk order fills](https://docs.decibel.trade/api-reference/websockets/bulkorderfills.md): User's bulk order fill events
- [Bulk orders](https://docs.decibel.trade/api-reference/websockets/bulkorders.md): User's bulk orders (multi-order submissions)
- [Market candlestick](https://docs.decibel.trade/api-reference/websockets/marketcandlestick.md): Real-time candlestick/OHLCV data for a specific market and interval
- [Market depth](https://docs.decibel.trade/api-reference/websockets/marketdepth.md): Market order book depth with aggregated price levels. Optional aggregationLevel parameter (1, 2, 5, 10, 100, or 1000) can be appended to the topic, defaults to 1 if not specified.
- [Market price](https://docs.decibel.trade/api-reference/websockets/marketprice.md): Real-time price updates for a specific market (oracle, mark, mid prices)
- [Market trades](https://docs.decibel.trade/api-reference/websockets/markettrades.md): Recent trades for a specific market
- [Notifications](https://docs.decibel.trade/api-reference/websockets/notifications.md): Real-time notifications for the user
- [Order update](https://docs.decibel.trade/api-reference/websockets/orderupdate.md): Order update for a specific user
- [User active twaps](https://docs.decibel.trade/api-reference/websockets/useractivetwaps.md): User's active TWAP (Time-Weighted Average Price) orders
- [User funding rate history](https://docs.decibel.trade/api-reference/websockets/userfundingratehistory.md): User's funding rate payment history
- [User open orders](https://docs.decibel.trade/api-reference/websockets/useropenorders.md): User's currently open orders
- [User order history](https://docs.decibel.trade/api-reference/websockets/userorderhistory.md): User's order history (filled, cancelled, rejected orders)
- [User positions](https://docs.decibel.trade/api-reference/websockets/userpositions.md): User's open positions with PnL and liquidation prices
- [User trade history](https://docs.decibel.trade/api-reference/websockets/usertradehistory.md): User's trade execution history
- [User trades](https://docs.decibel.trade/api-reference/websockets/usertrades.md): User's trades
- [Bulk Orders](https://docs.decibel.trade/developer-hub/guides/bulk-orders.md): Efficient order management for market makers
- [Vault Integration Guide](https://docs.decibel.trade/developer-hub/guides/vaults.md): Create and manage onchain vaults that pool capital under a single manager with interval-based performance fees and fungible share tokens.
- [Create Trading Account](https://docs.decibel.trade/developer-hub/on-chain/account-management/create-subaccount.md): Create a new Trading Account
- [Delegate Trading To](https://docs.decibel.trade/developer-hub/on-chain/account-management/delegate-trading.md): Delegate trading permissions to another account
- [Deposit to Trading Account](https://docs.decibel.trade/developer-hub/on-chain/account-management/deposit.md): Deposit collateral to a Trading Account
- [Revoke Delegation](https://docs.decibel.trade/developer-hub/on-chain/account-management/revoke-delegation.md): Revoke trading delegation from an account
- [Withdraw from Trading Account](https://docs.decibel.trade/developer-hub/on-chain/account-management/withdraw.md): Withdraw collateral from a Trading Account
- [Approve Max Builder Fee](https://docs.decibel.trade/developer-hub/on-chain/builder-fee/approve-max-builder-fee.md): Approve maximum builder fee for a Trading Account
- [Revoke Max Builder Fee](https://docs.decibel.trade/developer-hub/on-chain/builder-fee/revoke-max-builder-fee.md): Revoke maximum builder fee approval for a Trading Account
- [Cancel Bulk Order](https://docs.decibel.trade/developer-hub/on-chain/order-management/cancel-bulk-order.md): Cancels a bulk order for the specified account. Equivalent to submitting a bulk order with no price levels.
- [Cancel Client Order](https://docs.decibel.trade/developer-hub/on-chain/order-management/cancel-client-order.md): Cancel an order by client-assigned order ID
- [Cancel Order](https://docs.decibel.trade/developer-hub/on-chain/order-management/cancel-order.md): Cancel an order by order ID
- [Cancel TWAP Order](https://docs.decibel.trade/developer-hub/on-chain/order-management/cancel-twap-order.md): Cancel a TWAP order
- [Place Bulk Order](https://docs.decibel.trade/developer-hub/on-chain/order-management/place-bulk-order.md): Place a post-only bulk order on the exchange
- [Place Order](https://docs.decibel.trade/developer-hub/on-chain/order-management/place-order.md): Place a limit order on the exchange
- [Place TWAP Order](https://docs.decibel.trade/developer-hub/on-chain/order-management/place-twap-order.md): Place a Time-Weighted Average Price (TWAP) order
- [Contract Addresses & Helpers](https://docs.decibel.trade/developer-hub/on-chain/overview/contract-reference.md): Package addresses and helper functions for building Decibel transactions
- [Formatting Prices and Sizes for Orders](https://docs.decibel.trade/developer-hub/on-chain/overview/formatting-prices-sizes.md): Learn how to convert decimal prices and sizes to chain units using market configuration from the v1/markets endpoint
- [On-Chain Reference](https://docs.decibel.trade/developer-hub/on-chain/overview/index.md): Direct transaction reference for building on Decibel without the SDK
- [Market Parameters](https://docs.decibel.trade/developer-hub/on-chain/overview/market-parameters.md): Min order size, lot size, tick size, and precision for all live Decibel markets
- [Optimized Transaction Building](https://docs.decibel.trade/developer-hub/on-chain/overview/optimized-building.md): For better performance, you can build transactions synchronously using ABI data, a replay protection nonce, and the chain ID. This avoids network calls during transaction construction
- [Cancel TP/SL Order for Position](https://docs.decibel.trade/developer-hub/on-chain/position-management/cancel-tp-sl-order.md): Cancel a take-profit or stop-loss order for a position
- [Place TP/SL Order for Position](https://docs.decibel.trade/developer-hub/on-chain/position-management/place-tp-sl-order.md): Place take-profit and/or stop-loss orders for an existing position
- [Update SL Order for Position](https://docs.decibel.trade/developer-hub/on-chain/position-management/update-sl-order.md): Update an existing stop-loss order for a position
- [Update TP Order for Position](https://docs.decibel.trade/developer-hub/on-chain/position-management/update-tp-order.md): Update an existing take-profit order for a position
- [Activate Vault](https://docs.decibel.trade/developer-hub/on-chain/vault/activate.md): Activate a vault to accept contributions
- [Contribute to Vault](https://docs.decibel.trade/developer-hub/on-chain/vault/contribute.md): Contribute funds to a vault in exchange for shares
- [Create and Fund Vault](https://docs.decibel.trade/developer-hub/on-chain/vault/create-and-fund.md): Create a new vault with optional initial funding
- [Delegate DEX Actions To](https://docs.decibel.trade/developer-hub/on-chain/vault/delegate-dex-actions.md): Delegate trading actions to another account for a vault
- [Redeem from Vault](https://docs.decibel.trade/developer-hub/on-chain/vault/redeem.md): Redeem shares from a vault for underlying assets
- [Developer Hub](https://docs.decibel.trade/developer-hub/overview.md): Build automated trading systems on Decibel
- [Auto-Deleveraging (ADL)](https://docs.decibel.trade/for-traders/auto-deleveraging.md): Decibel's final circuit breaker for extreme market conditions
- [DLP Vault](https://docs.decibel.trade/for-traders/dlp-vault.md): The protocol-owned vault that provides exchange liquidity and serves as the backstop liquidator. Uses the same vault infrastructure as user-created vaults, continuously quoting bid/ask prices across all supported markets.
- [Fees](https://docs.decibel.trade/for-traders/fees.md): Trading fees and fee structure on Decibel
- [Funding Rates](https://docs.decibel.trade/for-traders/funding-rates.md): How continuous funding keeps perp prices aligned with spot
- [Liquidations](https://docs.decibel.trade/for-traders/liquidations.md): How liquidations work on Decibel and what to expect
- [Margin](https://docs.decibel.trade/for-traders/margin.md): How cross-margin and leverage work on Decibel
- [Multi-Collateral](https://docs.decibel.trade/for-traders/multi-collateral.md): Use multiple asset types as margin from a single account
- [What is Decibel?](https://docs.decibel.trade/for-traders/overview.md): A fully on-chain perpetual futures exchange with cross-chain deposits
- [Perpetuals vs Spot](https://docs.decibel.trade/for-traders/perps-vs-spot.md): Understanding the difference between perpetual futures and spot trading
- [Vaults](https://docs.decibel.trade/for-traders/vaults.md): Contribute to a trader's vault or launch your own. Managers trade with pooled capital and earn interval-based fees on profits.
- [Decibel Documentation](https://docs.decibel.trade/index.md): Trader and developer documentation for integrating with Decibel's fully on-chain perpetuals exchange.
- [Authenticated Requests](https://docs.decibel.trade/quickstart/authenticated-requests.md): Learn how to send authenticated requests by signing and submitting on-chain transactions
- [Builder Codes](https://docs.decibel.trade/quickstart/builder-codes.md): Learn about Decibel's technical architecture and how builders can leverage the platform
- [Core Concepts](https://docs.decibel.trade/quickstart/concepts.md): Mental model for building on Decibel: accounts, orderbook, perps, vaults, and APIs.
- [Market Data](https://docs.decibel.trade/quickstart/market-data.md): Learn how to send unauthenticated requests to access public market data
- [Client API Key Setup](https://docs.decibel.trade/quickstart/node-api-key.md): Learn how to set up a Client API key from Geomi to access Decibel's GET APIs
- [Placing Your First Order](https://docs.decibel.trade/quickstart/placing-your-first-order.md): Learn the minimum required code to build, sign, and submit your first order transaction
- [TypeScript Starter Kit](https://docs.decibel.trade/quickstart/typescript-starter-kit.md): Place orders via REST API and stream market data via WebSocket. Get your first trade in under 10 minutes, then customize the bot for your strategy.
- [Audits](https://docs.decibel.trade/security/audits.md): Third-party security audit reports for Decibel smart contracts.
- [Advanced](https://docs.decibel.trade/typescript-sdk/advanced.md): Gas price management, fee payer behavior, and time synchronization
- [Configuration](https://docs.decibel.trade/typescript-sdk/configuration.md): Network presets and configuration for the Decibel TypeScript SDK
- [Error responses](https://docs.decibel.trade/typescript-sdk/error-responses.md): Error codes and handling for TypeScript SDK functions
- [Installation](https://docs.decibel.trade/typescript-sdk/installation.md): Install the Decibel TypeScript SDK and its peer dependencies
- [TypeScript SDK Overview](https://docs.decibel.trade/typescript-sdk/overview.md): Decibel TypeScript SDK for reading market data and submitting transactions on Aptos
- [Read SDK](https://docs.decibel.trade/typescript-sdk/read-sdk.md): Query market data, account state, and subscribe to real-time updates
- [Write SDK](https://docs.decibel.trade/typescript-sdk/write-sdk.md): Submit trades and manage Trading Accounts, positions, and vaults

## OpenAPI Specs

- [openapi](https://docs.decibel.trade/api-reference/openapi.json)

## AsyncAPI Specs

- [asyncapi](https://docs.decibel.trade/api-reference/asyncapi.json)


Built with [Mintlify](https://mintlify.com).