深色模式

開始使用

概覽

Lapid SDK 讓 iOS、Android 與 Web App 取得台股上市、上櫃、興櫃的日 K、籌碼、基本面與公司資料,並在每日新版發佈後自動更新。

iOS
import LapidSDK

let client = LapidClient(configuration: LapidConfiguration(
    appKey: appKey,
    baseURL: URL(string: "https://sdk-api.lapidinsight.com")!,
    attestation: AppAttestProvider()))

let id = try await client.resolveSecurity(.symbol("2330"))
let price = try await client.priceDaily(securityId: id)
Android
val client = LapidClient(context, LapidConfig(
    appKey = appKey,
    baseUrl = "https://sdk-api.lapidinsight.com",
    attestation = PlayIntegrityProvider(context, cloudProjectNumber)))

val price = client.priceDaily(client.resolve(SecurityRef.Symbol("2330")))
// 不再使用時呼叫 client.close()
Web
import { LapidClient } from '@lapid/sdk-core';

const client = new LapidClient({
  baseUrl: 'https://sdk-api.lapidinsight.com',
  tokenSource: { getToken: async () => fetchTokenFromYourBackend() },
});
const { release } = await client.getReleaseCurrent();
本版為試點版,只能連測試環境,且只接受 debug 類型的裝置驗證。詳見「測試環境與限制」。

平台與需求

項目
iOS
Android
Web
套件
Swift Package LapidSDK
Gradle 模組 lapid-sdk,Compose 元件另加 lapid-sdk-compose,Play Integrity 另加 lapid-sdk-playintegrity
@lapid/sdk-core
最低版本
iOS 15、Swift 6
minSdk 24、Java 17
Node 24,或支援 fetch 與 crypto.subtle 的瀏覽器
第三方依賴
無
無(核心模組)
無
發佈管道
XCFramework,本地 Swift Package,以檔案交付
本地 Maven repo,以檔案交付
待定,目前為私有套件

從哪裡開始

  • 第一次整合:依序讀「安裝 SDK」「設定 appKey」「第一個請求」。
  • 想了解資料怎麼來、為什麼會換版:讀「核心觀念」。
  • 查方法簽章、欄位與錯誤碼:到「參考」。

資料集

SDK 提供 16 個資料集,點進去可看欄位與單位。

資料集
ID
內容
更新頻率
歷史起點
price.daily
個股每日的開高低收、成交量與成交金額。
每日
2019-01-02
chips.institutional
外資、投信、自營商每日的買賣超股數。
每日
2022-05-03
chips.margin
個股每日的融資買進、賣出、現償與餘額。
每日
2025-01-02
chips.shortBorrow
個股每日的融券與借券賣出、回補與餘額。
每日
2025-01-02
chips.dayTrade
個股每日的當沖成交量與買賣金額。
每日
2025-01-02
chips.foreignHolding
個股每日的外資及陸資持股股數與比率。
每日
2025-01-02
valuation.daily
個股每日的本益比、股價淨值比、殖利率與對應股利。
每日
2025-01-02
chips.shareDistribution
集保結算所每週公布的股權分散表,依 15 個持股級距列出人數與股數。
每週
2025-08-08
revenue.monthly
個股每月營收,含累計營收與月增、年增、累計年增率。
每月
2019-01
financials.ratios
個股每季與年度的獲利、償債、週轉等財務比率。
每季
2019 Q1
financials.statements
資產負債表、損益表與現金流量表,以科目路徑列出的長格式資料。
每季
2019(回補中,以 `historyStart` 為準)
corporate.dividends
個股各期的股利分派,含現金股利、股票股利與決議進度。
事件
2019
corporate.exRights
個股的除權息事件與參考價。
事件
2019
alerts
注意股、處置股與鉅額交易的公告,以 `kind` 區分類別。
事件
2025-01-02
company.profile
公司的基本資料與董監事、經理人名單,每檔證券一份快照。
快照
快照
index.daily
加權指數與櫃買指數的每日開高低收,key 為 `TAIEX` 或 `TPEX`。
每日
TAIEX 2019-04-03;TPEX 2020-05-07