深色模式

指南

取得資料

每個資料集都有對應的方法,參數是證券 id;先用 resolveSecurity(iOS)或 resolve(Android)把代號轉成 id。

iOS
let id = try await client.resolveSecurity(.symbol("2330"))
let price = try await client.priceDaily(securityId: id)
let flows = try await client.institutional(securityId: id)
let results = try await client.searchSymbols("台積")
Android
val id = client.resolve(SecurityRef.Symbol("2330"))
val price = client.priceDaily(id, range = ChartRange.Y1)
val flows = client.institutional(id)
val results = client.symbols().search("台積")
Web
const { release } = await client.getReleaseCurrent();
const { data: price } = await client.getPriceDaily(release, securityId);
const { data: flows } = await client.getDataset('chips.institutional', release, securityId);

Web 端沒有代號解析、區間裁切與快取,securityId 需自行由 getSymbols(release) 查出。

常用方法

要做的事
iOS
Android
代號轉 id
resolveSecurity(.symbol("2330"))
resolve(SecurityRef.Symbol("2330"))
搜尋證券
searchSymbols("台積")
symbols().search("台積")
日 K
priceDaily(securityId:)
priceDaily(securityId, range = ChartRange.Y1)
三大法人
institutional(securityId:)
institutional(securityId)
融資、融券借券、當沖、外資持股
margin、shortBorrow、dayTrade、foreignHolding
同名方法
估值
valuation(securityId:)
valuation(securityId)
月營收、財務比率、財報
revenueMonthly、financialRatios、financialStatements
同名方法
股利、除權息、警示、集保
dividends、exRights、alerts、shareDistribution
同名方法
公司資料
companyProfile(securityId:)
companyProfile(securityId)
指數
indexDaily(key: "TAIEX")
indexDaily("TAIEX")
欄位標籤與格式
presentation(dataset:)
presentation(dataset)

完整簽章與三端差異見 LapidClient 方法。

資料格式

  • 時間序列是欄式陣列:每個欄位一個陣列、舊到新,第 i 個元素對應同一天。
  • 金額為元;量一律為「股」,要換成「張」請除以 1,000;比率為小數;缺值為 null。
  • 週 K、月 K 由 SDK 從日 K 聚合。

區間

  • iOS 的 range 是起日或最少根數(PriceRange);Android 的 range 是 ChartRange(M1 到 MAX)加 warmupDays。
  • 只有日頻資料集會依區間少抓分塊;月營收、財報等一律取全部。
  • 要算均線等指標時,用 warmupDays(Android)或 minimumBars(iOS)多取區間前的資料。

要注意的資料特性

  • 各資料集起點不同:日 K 與財報 2019 起、三大法人 2022-05-03 起、籌碼與估值多為 2025 起。以回傳的 historyStart 為準。
  • 興櫃證券沒有日 K,呼叫 priceDaily 會丟 DATASET_NOT_FOUND。請用 board == emerging 判斷。
  • 某個資料集可能對某檔證券不存在,這不是錯誤,畫面應顯示「無資料」。
  • ETF 尚未支援。

各資料集的使用陷阱見 資料集總覽。