iOS

• iOS 13.0+
• Swift 5.9+ and Xcode 15+
• Swift and Objective-C

platform :ios, '13.0'
use_frameworks! :linkage => :static

target 'YourApp' do
  pod 'WhaleCore'
end

WhaleCore is distributed through a private CocoaPods source. Integration support supplies the source and credentials.

import WhaleCore

let config = WhaleCoreConfig(
    logLevel: .info,
    appKey: "your_app_key",
    appSecret: "your_app_secret",
    appId: "your_app_id",
    defaultAccountChannel: "lb_hk",
    token: userAccessToken,
    refreshToken: userRefreshToken,
    language: .en
)
config.tokenDelegate = session
WhaleCoreService.initialize(config: config)

Whale supplies project credentials and the default account channel. Broker’s login flow obtains the Client token and refreshToken. Never log credentials or complete tokens.

Implement WhaleCoreTokenDelegate to persist renewed credentials. Optional resolveExpiredToken can perform silent login when the refresh token also fails. Concurrent 401 responses trigger a single recovery whose result is shared by pending requests.

func didRefreshToken(_ token: String, refreshToken: String) {
    saveSecurely(token, refreshToken)
}

func resolveExpiredToken(completion: @escaping (String?, String?) -> Void) {
    silentLogin { completion($0.token, $0.refreshToken) }
}

To let the host manage trading passwords, set tradePasswordEnabled = true and assign WhaleCoreTradeAuthDelegate before initialization. Otherwise, the SDK manages trade authentication.

WhaleCoreService.onResume()
WhaleCoreService.onPause()
WhaleCoreService.logoutAndDestroy()

Destroy clears local tokens, closes WebSockets, and releases services. After account switching, initialize again and re-register delegates and subscriptions.

Use WhaleCoreService.requestService to call TradingAPI endpoints that do not yet have a typed WhaleCore service. Take the endpoint path, parameters, and response schema from the TradingAPI documentation. The host supplies those request values; WhaleCore adds the common parameters and headers for signing, authentication, and tracing. If login or trade authentication expires, the SDK recovers it and retries once.

WhaleCoreHTTPRequest exposes:

The response provides the raw JSON in bodyString, its UTF-8 representation in bodyData, and response headers in headers. Swift can decode the response directly into a Decodable model.

struct MemberInfo: Decodable {
    let id: String
    let name: String
}

let request = WhaleCoreHTTPRequest(
    method: .get,
    path: "/v2/member/info"
)
request.query = ["include_accounts": true]

let response = try await WhaleCoreService.requestService.send(request)
let member: MemberInfo = try response.decode()
print(member.name)

For an endpoint that requires trade authentication:

let request = WhaleCoreHTTPRequest(
    method: .get,
    path: "/v5/orders/today"
)
request.requiresTradeToken = true

let response = try await WhaleCoreService.requestService.send(request)
print(response.bodyString)

let subscription = WhaleCoreService.quotesService
    .subscribe(counters: ["ST/US/AAPL", "ST/HK/00700"])
    .detail.depth.trade.preTrade.postTrade
    .start { updates, error in
        updates?.forEach { print($0.counter, $0.stock.lastPrice ?? 0) }
    }

await subscription.cancel()

Selectable data includes list, detail, depth, trade, broker, preTrade, postTrade, and nightTrade.

Order requests use clientRequestId as an idempotency key. Reuse it when retrying the same order and generate a new value for a new order. Public models cover limit, market, LIT, MIT, trailing-stop-limit, and take-profit/stop-loss attached orders.

let common = WhaleCoreOrderCommon(
    counterId: "ST/US/AAPL",
    side: .buy,
    quantity: .byCount(NSDecimalNumber(value: 100)),
    settlementCurrency: "USD",
    clientRequestId: UUID().uuidString
)
let request = WhaleCoreOrderSubmitRequest.limit(
    common: common, kind: .lo, price: NSDecimalNumber(string: "180")
)
let result = try await WhaleCoreService.orderService.submitOrder(request)

Order events use addDelegate / removeDelegate: the first delegate starts the feed and removal of the final delegate stops it.