跳轉到

finlab

finlab.login

login(api_token=None)

登錄量化平台。

可以至 api_token查詢頁面 獲取api_token,傳入函數後執行登錄動作。 之後使用Finlab模組的會員功能時,系統就不會自動跳出請求輸入api_token的GUI頁面。 若傳入的api_toke格式有誤,系統會要求再次輸入。

PARAMETER DESCRIPTION
api_token

FinLab api_token

TYPE: str DEFAULT: None

Source code in finlab/__init__.py
def login(api_token=None):
    """登錄量化平台。

    可以至 [api_token查詢頁面](https://ai.finlab.tw/api_token/) 獲取api_token,傳入函數後執行登錄動作。
    之後使用Finlab模組的會員功能時,系統就不會自動跳出請求輸入api_token的[GUI頁面](https://ai.finlab.tw/api_token/)。
    若傳入的api_toke格式有誤,系統會要求再次輸入。

    Args:
        api_token (str): FinLab api_token
    """
    lp = LoginPanel()

    if api_token:
        lp.login(api_token)
        return

    if lp.gui_supported():
        lp.display_gui()
    else:
        lp.display_text_input()

finlab.get_token

get_token()

取得登錄會員的finlab_id。

若未登錄過,會跳出登錄頁面請求登錄。

RETURNS DESCRIPTION
str

finlab api token

Source code in finlab/__init__.py
def get_token():
    """取得登錄會員的finlab_id。

    若未登錄過,會跳出登錄頁面請求登錄。

    Returns:
        (str): finlab api token
    """
    if 'FINLAB_API_TOKEN' not in os.environ:
        login()

    return os.environ['FINLAB_API_TOKEN'][:64]