finlab

finlab 模組負責登入與憑證管理。在自己的電腦或 Colab 用瀏覽器登入一次，之後就會自動使用；伺服器、Docker、排程這類沒有瀏覽器的環境，改用環境變數憑證。

選哪個函式

在自己的電腦或 Colab 登入

本機電腦（推薦）

在終端機執行一次，之後同一台電腦的 Python 都會自動使用這份憑證：

python -m finlab login

或在 Python / Jupyter 中登入：

import finlab

# 1. 呼叫 login() 不帶參數
# 2. 瀏覽器會自動開啟 FinLab 登入頁面
finlab.login()

# 3. 登入成功後，憑證會儲存在 ~/.finlab/credentials.json
# 4. 之後使用不需要再次登入

• 憑證儲存位置：~/.finlab/credentials.json
• 有效期限：60 天（自動更新）

若瀏覽器登入失敗、被拒絕或逾時，finlab.login() 會拋出 finlab.exceptions.LoginError（RuntimeError 的子類別），不會再默默返回。

Google Colab

import finlab

finlab.login()  # 依畫面指示在瀏覽器完成登入

login(api_token) -> None

在伺服器、Docker、排程使用

沒有瀏覽器的環境不用呼叫 finlab.login()。先在已登入的本機匯出憑證：

python -m finlab token --env
# export FINLAB_REFRESH_TOKEN="..."
# export FINLAB_SESSION_ID="..."
# export FINLAB_API_KEY="..."

再把這三個值設成目標環境的環境變數（例如 docker-compose、GitHub Actions secrets、Cloud Functions 環境變數），程式中不需要呼叫 finlab.login()：

from finlab import data

close = data.get('price:收盤價')  # 自動讀取 FINLAB_REFRESH_TOKEN 等環境變數

確認登入狀態與登出

在終端機查看狀態或登出：

python -m finlab status   # 顯示登入狀態與方案
python -m finlab logout   # 清除本機憑證並移除伺服器端 session

若曾設定環境變數憑證，登出時也請一併移除 FINLAB_REFRESH_TOKEN、FINLAB_SESSION_ID、FINLAB_API_KEY（以及舊版 FINLAB_API_TOKEN）。

在 Python 裡用 finlab.get_token() 確認是否已登入：

import finlab

try:
    token, token_type = finlab.get_token()
    print(f"✅ 已登入（{token_type}）")
except RuntimeError:
    print("❌ 未登入")

get_token() -> tuple[str, str]

FinLab 怎麼找到你的憑證

FinLab 會按照以下順序尋找認證資訊：

1. FINLAB_REFRESH_TOKEN + FINLAB_SESSION_ID + FINLAB_API_KEY 環境變數（三個都設定時才生效）
2. ~/.finlab/credentials.json：瀏覽器登入產生的憑證
3. FINLAB_ID_TOKEN 環境變數：供瀏覽器 / Pyodide 執行環境使用
4. FINLAB_API_TOKEN 環境變數：舊版 API Token（已棄用，會出現警告）
5. 互動式登入：以上都沒有時啟動瀏覽器登入

常見問題

下一步