Welcome to deepbookpy’s documentation!

deepbookpy is a Python library that allow everyone to interact with DeepBook on-chain protocol.

Contents:

• Getting Started
  • Install deepbookpy
  • Set up pysui config
  • Set up DeepBook Python SDK
  • Query DeepBook Protocol
  • On-Chain DeepBook Operations
• Flash Loans
  • Borrow Base Asset
  • Return Base Asset
  • Borrow Quote Asset
  • Return Quote Asset
  • Basic Flash Loan Example
  • Advanced Flash Loan Example
• Orders
  • Place a limit order
  • Place a market order
  • Cancel an order
  • Cancel all orders
• Pools
  • Retrieve Account Information
  • Retrieve Open Orders
  • Check Balance Manager
  • Get Order
  • Get Normalized Order
  • Get Quote Quantity Out
  • Get Base Quantity Out
  • Get Quantity Out
  • Get Level2 Range
  • Get Level2 Ticks from Mid
  • Get Locked Balance
  • Get Pool Trade Params
  • Get Vault Balances
  • Get Pool ID by assets
  • Get Mid Price of a Pool
  • Get Whitelist Status
• Staking and Governance
  • Stake
  • Unstake
  • Submit Proposal
  • Vote
• Swaps
  • Swap Exact Base For Quote
  • Swap Exact Quote For Base
• Deepbookpy
  • Submodules
  • deepbookpy.deepbook_client module
  • deepbookpy.transactions module
  • deepbookpy.utils module
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page