Jump to Content
BSXAPI Reference
GuidesAPI ReferenceChangelogDiscussions
v1.0

API ReferenceLog InBSX
API Reference
Log In
v1.0GuidesAPI ReferenceChangelogDiscussions

Overview

  • REST and WebSocket API
  • SDKs

BSX REST API

  • Overview
  • Sender and signer wallets
  • Authentication 🔐
  • Signing
  • Cancel Order v2
  • API Key life cycle
  • Chain
    • Get current chain configsget
  • Trades
    • Change user's collateral modepost
    • Modify margin of specific isolated positionpost
    • Update leverage of specific productpost
    • Change position margin mode of specific productpost
    • Get trade history of a product.get
    • Get trade history of an account.get
  • Collaterals
    • Get collateral liquidation history of an account.get
  • Tokens
    • Query collateral tokensget
    • Query tokens for swappingget
  • Market
    • Get oracle websocket assetsget
  • Orders
    • Request to cancel an orderdelete
    • Get order historyget
    • List all open ordersget
    • Cancel multiple ordersdelete
    • Create an orderpost
    • Cancel all open ordersdelete
    • Batch update orderspost
    • Get an orderget
    • Set weighted positionspost
    • Cancel an orderdelete
  • Portfolio
    • Get portfolio detailsget
    • Get realized PnLget
    • Get USDC settlements historyget
  • Products
    • Get the list of all markets on BSX.get
    • Get the L2 order book.get
    • Get historical data of funding rate on BSX.get
  • Subaccounts
    • Delete a subaccountdelete
    • Create a subaccountpost
    • Get API keys for one or all subaccountsget
    • Get all collateral tokens of a subaccountget
    • Update the frozen status of a subaccountpost
    • Get portfolio details of a subaccountget
    • Register a subaccount signerpost
    • Transfer funds from the main account to a subaccountpost
    • Transfer funds from a subaccount to the main accountpost
    • Transfer funds from a subaccount to another subaccountpost
  • Transfers
    • Get transfer historyget
    • Withdraw USDC collateral to the wallet.post
  • Users
    • Get user account infoget
    • Returns the account API keys.get
    • Delete an API key.delete
    • Create a new API key.post
    • Register a user signing wallet.post
    • De-register a user signing wallet.delete
  • Vaults
    • Get vault order historyget

BSX WEBSOCKET FEED

  • Overview
  • Connection
  • Messages
  • Public endpoints
    • Orderbook
    • Oracle Prices
    • Ticker
    • Trades
    • Estimated Funding rate
  • Private endpoints
    • Authentication 🔐
    • Orders
    • Create order
    • Cancel order
    • Positions
Powered by 

SDKs

The Python and JS SDKs are available to make programmatic trading easier

Python: https://pypi.org/project/bsx-sdk-py
JS: https://www.npmjs.com/package/@bsx-exchange/client

For feedback, support or any inquiries, please contact [email protected]