文件

指標快照

提供特定時點的財務指標快照，適合橫截面分析。

財務指標

GET/v1/financial-metrics/snapshot

前往儀表板

Overview#

提供特定時點的財務指標快照，適合橫截面分析。

此 endpoint 提供穩定的契約格式，可直接整合至資料管線、回測系統與自動化流程。

Request#

此 endpoint 常見使用情境：

估值篩選、同業比較與即時風險檢查
建立單一來源的資料查詢層，降低跨來源整合成本。
在研究與生產環境共用同一組 request / response 契約。

建議接入步驟：

1. 在 header 放入 X-API-Key。
2. 先以單一 ticker 或小範圍條件驗證回應格式。
3. 確認欄位後再擴展至批次查詢與分頁流程。

curl -X GET "https://api.twmarketdata.com/v1/financial-metrics/snapshot?ticker=2330&limit=10" \
  -H "X-API-Key: your_api_key_here"

欄位	型別	Required	說明
ticker	string	yes	股票代碼，例如 2330。
date	string	no	指定日期（YYYY-MM-DD）。
start_date	string	no	查詢區間起始日期。
end_date	string	no	查詢區間結束日期。
limit	integer	no	回傳筆數上限。
offset	integer	no	分頁偏移量。

Response#

回應採統一 envelope，固定包含 dataset、source_role、freshness、lineage、data。

data 欄位會依 endpoint 性質回傳陣列或單一物件，但欄位命名與型別維持穩定。

{
  "dataset": "metrics_snapshot",
  "source_role": "canonical",
  "freshness": "2026-04-21T10:30:00+08:00",
  "lineage": {
    "source": "TWSE/TPEx",
    "ingested_at": "2026-04-21T10:30:02+08:00",
    "trace_id": "metrics_snapshot_2330_20260421"
  },
  "data": {
    "ticker": "2330",
    "date": "2026-04-21",
    "pe": 26.8,
    "pb": 6.2,
    "dividend_yield_pct": 1.9,
    "market_cap": 21053000000000
  }
}

Field 說明#

欄位路徑	型別	說明
dataset	string	資料集識別名稱。
source_role	string	來源角色（canonical / fallback / helper）。
freshness	string	資料時效與更新節點。
lineage.trace_id	string	追蹤識別，用於審計與排查。
data	array \| object	實際資料內容。
data[].ticker	string	股票代碼或識別鍵。
data[].date	string	資料日期。
data[].value	number \| string	主要數值欄位。

使用建議#

建議使用 ticker 作為 join key，避免以名稱匹配造成錯配。
批次查詢請使用 limit / offset，避免單次大量請求超出 rate limit。
整合多 endpoint 時，請保留 source_role 與 lineage 以便驗證與排錯。

錯誤與邊界情況#

ticker 不存在時，回應 data 可能為空陣列。
資料尚未更新時，請依 freshness 判斷是否需要延後重試。
canonical 暫不可用時，可能出現 fallback source_role。

請求與回應

請求範例

curl -X GET "https://api.twmarketdata.com/v1/financial-metrics/snapshot?ticker=2330&limit=10" \
  -H "X-API-Key: your_api_key_here"

狀態碼

成功回傳資料。

JSON

{
  "dataset": "metrics_snapshot",
  "source_role": "canonical",
  "freshness": "2026-04-21T10:30:00+08:00",
  "lineage": {
    "source": "TWSE/TPEx",
    "ingested_at": "2026-04-21T10:30:02+08:00",
    "trace_id": "metrics_snapshot_2330_20260421"
  },
  "data": {
    "ticker": "2330",
    "date": "2026-04-21",
    "pe": 26.8,
    "pb": 6.2,
    "dividend_yield_pct": 1.9,
    "market_cap": 21053000000000
  }
}

Request#

此 endpoint 常見使用情境：

估值篩選、同業比較與即時風險檢查

建立單一來源的資料查詢層，降低跨來源整合成本。

在研究與生產環境共用同一組 request / response 契約。

建議接入步驟：

1. 在 header 放入 X-API-Key。

2. 先以單一 ticker 或小範圍條件驗證回應格式。

3. 確認欄位後再擴展至批次查詢與分頁流程。

curl -X GET "https://api.twmarketdata.com/v1/financial-metrics/snapshot?ticker=2330&limit=10" \ -H "X-API-Key: your_api_key_here"

欄位	型別	Required	說明
ticker	string	yes	股票代碼，例如 2330。
date	string	no	指定日期（YYYY-MM-DD）。
start_date	string	no	查詢區間起始日期。
end_date	string	no	查詢區間結束日期。
limit	integer	no	回傳筆數上限。
offset	integer	no	分頁偏移量。

Response#

回應採統一 envelope，固定包含 dataset、source_role、freshness、lineage、data。

data 欄位會依 endpoint 性質回傳陣列或單一物件，但欄位命名與型別維持穩定。

{ "dataset": "metrics_snapshot", "source_role": "canonical", "freshness": "2026-04-21T10:30:00+08:00", "lineage": { "source": "TWSE/TPEx", "ingested_at": "2026-04-21T10:30:02+08:00", "trace_id": "metrics_snapshot_2330_20260421" }, "data": { "ticker": "2330", "date": "2026-04-21", "pe": 26.8, "pb": 6.2, "dividend_yield_pct": 1.9, "market_cap": 21053000000000 } }

Field 說明#

欄位路徑	型別	說明
dataset	string	資料集識別名稱。
source_role	string	來源角色（canonical / fallback / helper）。
freshness	string	資料時效與更新節點。
lineage.trace_id	string	追蹤識別，用於審計與排查。
data	array \| object	實際資料內容。
data[].ticker	string	股票代碼或識別鍵。
data[].date	string	資料日期。
data[].value	number \| string	主要數值欄位。