文件

公司基本資料

提供公司識別、上市櫃別、產業分類與交易所資訊。

公司主檔

GET/v2/datasets/issuer-profile

前往儀表板

Overview#

此 endpoint 提供公司識別主檔，包含 ticker、公司名稱、上市櫃別、交易所與產業分類。

資料適合作為所有查詢流程的基礎維度，先建立主檔可降低後續 join 錯誤。

Request#

此 endpoint 常見使用情境：

建立 ticker 與公司名稱對照表。
做市場別與產業別分群分析。
在批次流程中過濾停牌、下市或狀態異常標的。

建議接入步驟：

1. 帶入 API key 與 ticker 後即可查詢單一公司主檔。
2. 若需要搜尋用途，可在 query 帶入公司名關鍵字。

curl -G "https://api.twmd.example/v2/datasets/issuer-profile" \
  -H "X-API-Key: your_api_key_here" \
  --data-urlencode "ticker=2330"

欄位	型別	Required	說明
ticker	string	no	公司代號。與 query 至少擇一。
query	string	no	公司名稱或代號關鍵字。
market	string	no	市場別篩選，例如 TWSE、TPEx。

Response#

回應結構固定為 dataset、rows、count。

rows 依查詢條件回傳單筆或多筆公司主檔資料。

{
  "dataset": "issuer_profile",
  "rows": [
    {
      "symbol": "2330",
      "company_name": "台灣積體電路製造股份有限公司",
      "exchange": "TWSE",
      "market_type": "上市",
      "industry": "半導體",
      "status": "active"
    }
  ],
  "count": 1
}

Field 說明#

欄位路徑	型別	說明
dataset	string	固定為 issuer_profile。
rows[].symbol	string	公司代號（內部對應 ticker）。
rows[].company_name	string	公司名稱。
rows[].exchange	string	交易所識別。
rows[].market_type	string	上市櫃別或市場板塊。
rows[].industry	string	產業分類。
rows[].status	string	公司狀態（正常、停牌、下市等）。
count	integer	回傳資料筆數。

使用建議#

公司狀態與分類可能異動，建議定期同步主檔而非僅在初始化時查詢一次。
跨來源合併時請固定使用同一識別鍵與生效日期規則。

錯誤與邊界情況#

ticker 與 query 皆未提供
認證失敗
查無公司資料

請求與回應

請求範例

curl -G "https://api.twmd.example/v2/datasets/issuer-profile" \
  -H "X-API-Key: your_api_key_here" \
  --data-urlencode "query=台積電"

狀態碼

成功回傳公司主檔

{
  "dataset": "issuer_profile",
  "rows": [
    {
      "symbol": "2330",
      "company_name": "台灣積體電路製造股份有限公司",
      "exchange": "TWSE",
      "market_type": "上市",
      "industry": "半導體",
      "status": "active"
    }
  ],
  "count": 1
}