Android

The delivery contains WhaleCore and Engine AARs plus a script that injects local and remote dependencies:

apply(from = "<path-to>/whalecore/whalecore.gradle")

The host configures Android minSdk, JVM target 11 or later, and the Kotlin plugin. For minSdk < 26, the script configures core-library desugaring. Confirm the final support matrix for the delivered version.

initialize performs network warm-up and blocks; call it on an IO thread. Repeated and concurrent calls are safe, and only the first takes effect.

val config = WhaleCoreConfig(
    appId = "<assigned>",
    appKey = "<assigned>",
    appSecret = "<assigned>",
    token = accessToken,
    refreshToken = refreshToken,
    defaultAccountChannel = "lb_hk",
    language = WhaleCoreLanguage.EN,
    logLevel = WhaleCoreLogLevel.INFO
)

withContext(Dispatchers.IO) {
    WhaleCore.initialize(application, config, isDebug = BuildConfig.DEBUG)
}

Never log project credentials or complete tokens.

WhaleCore.resume()
WhaleCore.pause()

withContext(Dispatchers.IO) { WhaleCore.destroy() }

Destroy releases coroutines, WebSockets, caches, and native handles. It can then be initialized with another account.

Getting a service before initialization throws IllegalStateException. Public operations generally offer both a coroutine method and a callback-based *Async variant.

Use WhaleCore.getRequestService() 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.

HttpRequest is immutable and accepts:

send returns an HttpResponse containing the raw JSON bodyString and response headers. Parse the body with the JSON library used by the host app.

import longbridge.whalecore.business.request.model.HttpMethod
import longbridge.whalecore.business.request.model.HttpRequest

val request = HttpRequest(
    method = HttpMethod.GET,
    path = "/v2/member/info",
    query = mapOf("include_accounts" to true)
)

val response = WhaleCore.getRequestService().send(request)
val member = json.decodeFromString<MemberInfo>(response.bodyString)
println(member.name)

For an endpoint that requires trade authentication:

val request = HttpRequest(
    method = HttpMethod.GET,
    path = "/v5/orders/today",
    requiresTradeToken = true
)

val response = WhaleCore.getRequestService().send(request)
println(response.bodyString)

Java callers can use sendAsync(request, callback) instead of the suspending send method.

val quoteService = WhaleCore.getQuoteService()
val stock = quoteService.getStock("ST/US/AAPL")

val subscription = quoteService.subscribe(
    listOf("ST/US/AAPL"), quoteCallback
).detail().depth().trade().start()

Observe events as SharedFlow or through lifecycle-aware callbacks. Cancel the returned Subscription when no longer needed.

OrderService covers today’s/history/detail queries, buying power, position detail, submission, replacement, cancellation, batch cancellation, cost estimates, and order events. Before submission, validation APIs cover:

• checkTradability
• getOrderConstraints
• validateOrder
• getQualifications
• acceptAgreement
• submitListedDerivAssessment

val orderService = WhaleCore.getOrderService()
val result = orderService.submitOrder(request)
orderService.observeOrderEvents(this, object : OrderEventCallback {
    override fun onChange(order: Order) { updateOrder(order) }
})

PortfolioService supports subscribe/unsubscribe, refresh, cash detail, position quotes, and member settings. WatchlistService supports group and stock mutations, cross-group moves, pinning, ordering, invalid-ticker cleanup, and events.

For a business API not yet wrapped by a typed service, use RequestService.send(HttpRequest). The SDK adds common parameters and auth headers and performs auth recovery; the caller parses the business response.