Skip to content
Longport WhaleLongport Whale
WhaleCoreSDK

Overview

WhaleCoreSDK capabilities, boundaries, and platform support

WhaleCoreSDK is a UI-free securities data SDK. Broker App implements its own interface, uses WhaleCore for client sessions, real-time data, and business services, and combines it with TradingAPI for additional Client-scoped HTTP capabilities.

Note
This documentation is derived from public interfaces in the WhaleCore iOS and Android source. Artifact locations, version compatibility, project credentials, and environments are supplied by the Whale project team.

When to use it

Fully custom UI
Broker designs every securities screen and interaction instead of using WhaleAppSDK UI.
Reusable client foundations
The SDK manages sessions, auth recovery, WebSockets, caching, and business data services.

Public capabilities

Module iOS Android Capability
Quotes quoteService() getQuoteService() Real-time quote subscriptions, K-lines, timeshares, historical trades, option-chain / option-detail subscriptions, and quote level with device eviction
Option calculator WhaleCoreOptionCalculator (static utility) OptionCalculator (static utility) Local Black-Scholes calculations: Greeks, theoretical price, intrinsic/time value, days to expiry, and probability of profit
Orders orderService() getOrderService() Submit, replace, cancel, attached orders, take-profit/stop-loss on a position, order preview, estimates, pre-trade validation, trade card selection, and order events
Portfolio portfolioService() getPortfoliosService() Portfolio subscriptions, cash details, member portfolio settings, and profit-and-loss analysis (cross-currency conversion happens inside the SDK; neither platform exposes an exchange-rate lookup API)
Watchlist watchlistService() getWatchlistService() Group and stock CRUD, ordering, pinning, invalid-ticker cleanup, and events
Requests requestService() getRequestService() HTTP requests with automatic common parameters and auth headers, with automatic recovery and retry on auth expiry
Note

The legacy standalone entry points WhaleCoreService.orderValidationService (iOS) and WhaleCore.getOrderValidationService() (Android) are deprecated — call the same-named methods on orderService() / getOrderService() instead.

SDK instrument identifiers use the CounterId form, such as ST/US/AAPL or ST/HK/00700.

Integration model

flowchart LR
    A[Broker App UI] --> B[WhaleCoreSDK]
    B --> C[Quotes and WebSockets]
    B --> D[Orders / portfolio / watchlists]
    B --> E[Automatic token renewal]
    A --> F[TradingAPI]
    F --> G[Client-scoped HTTP capabilities]

Platforms

Platform Status Guide
iOS Available; iOS 13+; Swift / Objective-C iOS
Android Available; Kotlin / Java Android
Web Available; WebAssembly in the browser; TypeScript TypeScript
Whale Docs