Skip to content

[FR]. OKX integration into OpenBB #7098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chandrasaripaka opened this issue Apr 24, 2025 · 0 comments
Open

[FR]. OKX integration into OpenBB #7098

chandrasaripaka opened this issue Apr 24, 2025 · 0 comments

Comments

@chandrasaripaka
Copy link

🚫 What's the problem of not having this feature?

OpenBB Desktop currently does not support integration with the OKX v5 API/WebSocket, which creates a significant gap for users who actively trade or manage portfolios on the OKX exchange. This limits real-time portfolio tracking, live trading, and automated strategy execution directly from the OpenBB platform.

As a result, users are forced to:

  • Manually export data from OKX and import it into OpenBB.
  • Run separate scripts or tools for order management and live data.
  • Miss out on real-time insights and alerts from OKX market movements.

This lack of native support diminishes the efficiency and usability of OpenBB for crypto traders who rely on OKX.


Describe the solution you would like

I propose a full integration of the OKX v5 API and WebSocket feed into OpenBB Desktop, providing seamless support for both real-time data and account operations. Key capabilities would include:

🔹 Market Data (via WebSocket)

  • Live ticker prices, trades, and depth (order book) for spot and derivatives.
  • Subscription-based WebSocket channels with reconnect and heartbeat handling.

🔹 Portfolio & Account

  • Fetch balances, positions, and order history via REST API.
  • Live account updates (balances, PnL, position changes) via WebSocket.

🔹 Trading Features

  • Place, update, and cancel spot/futures orders directly from OpenBB.
  • Access to margin, perpetual, and options trading where supported.

🔹 User Experience

  • Add OKX as an exchange in the "Brokerage" or "Crypto" tab.
  • Secure API key management through encrypted storage or OS-level secrets.
  • WebSocket status UI with auto-reconnect and debug logging.

🔄 Describe alternatives you've considered

  • CCXT Integration: CCXT provides partial OKX REST support but lacks WebSocket capabilities and doesn’t expose advanced OKX-specific features (e.g., account stream events).
  • Manual CSV uploads: This is time-consuming and lacks real-time updates, defeating the purpose of an interactive platform like OpenBB.
  • External bots/tools: These create fragmented workflows, requiring users to jump between platforms for monitoring and execution.

📝 Additional information

  • OKX v5 is their latest API standard with full WebSocket and REST coverage:
  • This integration aligns with OpenBB’s goal of providing multi-asset, broker-agnostic capabilities for retail and professional investors.
  • A successful implementation could also open the door to further integrations with other major crypto exchanges and DeFi protocols.

Let me know if you'd like this turned into a GitHub issue template or if you'd like help drafting a technical breakdown for contributors to implement it.

@chandrasaripaka chandrasaripaka changed the title [FR] [FR]. OKX integration into OpenBB Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant