Skip to content
Overview

WhaleSDK

Whale client SDK products, including graphical WhaleAppSDK and data-only WhaleCoreSDK

WhaleSDK is the umbrella name for Whale client SDK products. Broker selects a specific product based on whether a ready-made UI is required and which platform it targets.

Product UI Platforms Best fit
WhaleAppSDK Complete securities UI iOS, Android, WebTrade Integrate a graphical experience in Broker App, website, or web container
WhaleCoreSDK No UI iOS and Android available; WebAssembly in development Implement the complete securities UI in Broker App

Choose a product

The graphical SDK with iOS, Android, and WebTrade form factors.

The UI-free data SDK used with TradingAPI to implement the securities UI from scratch.

WhaleAppSDK

WhaleAppSDK supplies the implemented securities UI and business functionality in three form factors:

Broker App must also integrate system notifications and pass the standard message body to WhaleAppSDK. See Message-push integration for server channels, cloud credentials, and client responsibilities.

WebTrade

WebTrade is the web trading client form factor of WhaleAppSDK, equivalent to the web version of the iOS/Android App. It can be deployed on a standalone domain for direct user access or embedded in a Broker’s website via iframe; both methods use cookies and postMessage for SSO and page communication. WebTrade also supports PWA installation to the desktop.

WhaleCoreSDK

WhaleCoreSDK is the UI-free data SDK in WhaleSDK. It provides market-data subscriptions, WebSocket connectivity, request signing, and automatic token renewal. A Broker App combines WhaleCoreSDK with TradingAPI to implement its complete securities UI and business flow.

Start with the WhaleCoreSDK overview, then follow the iOS or Android guide.

Whale Docs