pip install decibel-python-sdkOr with uv:
uv add decibel-python-sdkSet the following environment variables:
# Required for write operations
export PRIVATE_KEY="your_private_key_hex"
# Optional: for better rate limits
export APTOS_NODE_API_KEY="your_aptos_node_api_key"New to Decibel? Follow the Getting Started Guide to create your API Wallet and get your API key from Geomi.
import asyncio
from decibel import NETNA_CONFIG
from decibel.read import DecibelReadDex
async def main():
read = DecibelReadDex(NETNA_CONFIG)
# Get all markets
markets = await read.markets.get_all()
for market in markets:
print(f"{market.market_name}: {market.max_leverage}x leverage")
# Get market prices
prices = await read.market_prices.get_all()
for price in prices:
print(f"{price.market}: ${price.mark_px}")
asyncio.run(main())import asyncio
import os
from aptos_sdk.account import Account
from aptos_sdk.ed25519 import PrivateKey
from decibel import (
NETNA_CONFIG,
BaseSDKOptions,
DecibelWriteDex,
GasPriceManager,
PlaceOrderSuccess,
TimeInForce,
amount_to_chain_units,
)
from decibel.read import DecibelReadDex
async def main():
private_key = PrivateKey.from_hex(os.environ["PRIVATE_KEY"])
account = Account.load_key(private_key.hex())
gas = GasPriceManager(NETNA_CONFIG)
await gas.initialize()
read = DecibelReadDex(NETNA_CONFIG)
markets = await read.markets.get_all()
btc = next(m for m in markets if m.market_name == "BTC/USD")
write = DecibelWriteDex(
NETNA_CONFIG,
account,
opts=BaseSDKOptions(gas_price_manager=gas),
)
result = await write.place_order(
market_name="BTC/USD",
price=amount_to_chain_units(100000.0, btc.px_decimals),
size=amount_to_chain_units(0.001, btc.sz_decimals),
is_buy=True,
time_in_force=TimeInForce.GoodTillCanceled,
is_reduce_only=False,
)
if isinstance(result, PlaceOrderSuccess):
print(f"Order placed! ID: {result.order_id}")
else:
print(f"Order failed: {result.error}")
await gas.destroy()
asyncio.run(main())import asyncio
from decibel import NETNA_CONFIG
from decibel.read import DecibelReadDex
async def main():
read = DecibelReadDex(NETNA_CONFIG)
def on_price(msg):
price = msg.price
print(f"BTC/USD: ${price.mark_px}")
unsubscribe = read.market_prices.subscribe_by_name("BTC/USD", on_price)
await asyncio.sleep(30)
unsubscribe()
await read.ws.close()
asyncio.run(main())See the examples directory for complete working examples:
- examples/read - REST API queries (markets, prices, positions, orders)
- examples/read/ws - WebSocket subscriptions (real-time streaming)
- examples/write - Trading operations (orders, deposits, withdrawals)
from decibel import MAINNET_CONFIG, TESTNET_CONFIG, NETNA_CONFIG
# MAINNET_CONFIG - Production network
# TESTNET_CONFIG - Test network
# NETNA_CONFIG - Dev networkfrom decibel.read import DecibelReadDex
read = DecibelReadDex(config, api_key=None)
# Market data
read.markets.get_all()
read.market_prices.get_all()
read.market_prices.get_by_name(market_name)
read.market_depth.get_by_name(market_name, limit=50)
read.market_trades.get_by_name(market_name)
read.market_contexts.get_all()
read.candlesticks.get_by_name(market_name, interval, start_time, end_time)
# User data
read.account_overview.get_by_addr(sub_addr=sub_addr)
read.user_positions.get_by_addr(sub_addr=sub_addr)
read.user_open_orders.get_by_addr(sub_addr=sub_addr)
read.user_order_history.get_by_addr(sub_addr=sub_addr)
read.user_trade_history.get_by_addr(sub_addr=sub_addr)
read.user_bulk_orders.get_by_addr(sub_addr=sub_addr)
read.user_subaccounts.get_by_addr(owner_addr=addr)
read.user_fund_history.get_by_addr(sub_addr=sub_addr)
read.user_funding_history.get_by_addr(sub_addr=sub_addr)
read.user_active_twaps.get_by_addr(sub_addr=sub_addr)
read.user_twap_history.get_by_addr(sub_addr=sub_addr)
# Other
read.delegations.get_all(sub_addr=sub_addr)
read.leaderboard.get_leaderboard()
read.portfolio_chart.get_by_addr(sub_addr=sub_addr, time_range="7d", data_type="pnl")
read.vaults.get_vaults()
read.trading_points.get_by_owner(owner_addr=addr)
# WebSocket subscriptions
read.market_prices.subscribe_by_name(market_name, callback)
read.market_prices.subscribe_all(callback)
read.market_depth.subscribe_by_name(market_name, aggregation_size, callback)
read.market_trades.subscribe_by_name(market_name, callback)
read.candlesticks.subscribe_by_name(market_name, interval, callback)
read.account_overview.subscribe_by_addr(sub_addr, callback)
read.user_positions.subscribe_by_addr(sub_addr, callback)
read.user_open_orders.subscribe_by_addr(sub_addr, callback)
read.user_order_history.subscribe_by_addr(sub_addr, callback)
read.user_trade_history.subscribe_by_addr(sub_addr, callback)
read.user_bulk_orders.subscribe_by_addr(sub_addr, callback)
read.user_active_twaps.subscribe_by_addr(sub_addr, callback)
read.user_notifications.subscribe_by_addr(sub_addr, callback)from decibel import DecibelWriteDex, TimeInForce
write = DecibelWriteDex(config, account, opts)
# Orders
write.place_order(market_name=..., price=..., size=..., is_buy=..., time_in_force=..., is_reduce_only=...)
write.cancel_order(order_id=..., market_name=...)
write.cancel_client_order(client_order_id=..., market_name=...)
write.place_bulk_orders(market_name=..., sequence_number=..., bid_prices=..., bid_sizes=..., ask_prices=..., ask_sizes=...)
write.cancel_bulk_order(market_name=...)
# TP/SL
write.place_tp_sl_order_for_position(market_name=..., tp_price=..., sl_price=..., ...)
write.update_tp_order_for_position(market_name=..., order_id=..., new_trigger_price=..., ...)
write.update_sl_order_for_position(market_name=..., order_id=..., new_trigger_price=..., ...)
# TWAP
write.place_twap_order(market_name=..., size=..., is_buy=..., is_reduce_only=..., twap_frequency_seconds=..., twap_duration_seconds=...)
write.cancel_twap_order(market_addr=..., order_id=...)
# Collateral
write.deposit(amount)
write.withdraw(amount)
# Vaults
write.deposit_to_vault(vault_address=..., amount=..., subaccount_addr=...)
write.withdraw_from_vault(vault_address=..., shares=...)
# Subaccounts
write.create_subaccount()
write.deactivate_subaccount(subaccount_addr=...)make setup # Install dependencies + pre-commit hooks
make # Run full quality pipeline (format, lint, typecheck, test)
make lint # Check for lint errors
make fix # Auto-fix lint and format issues
make typecheck # Run pyright type checking
make test # Run testsThe SDK uses ABI JSON files to build on-chain transactions. These are fetched from the deployed smart contracts and stored in src/decibel/abi/json/. They should be regenerated whenever the on-chain contracts are updated.
# Generate ABIs for a specific network (default: mainnet)
make abi
make abi NETWORK=testnet
make abi NETWORK=mainnet
# Generate ABIs for all networks
make abi-all- π Documentation - Full API documentation
- π Trading Platform - Decibel trading interface
- π¬ Discord - Community support
This project is licensed under the MIT License - see the LICENSE file for details.