finlab.portfolio

finlab.portfolio.Portfolio

Portfolio(reports)

Bases: Report

建構 Portfolio 物件。

PARAMETER	DESCRIPTION
`-`	代表投資組合的字典，key 為資產名稱，value 是回測報告與部位。 TYPE: `reports (Dict[str, Tuple[Report, float]]`

Example

組合多個策略

from finlab import sim
from finlab.portfolio import Portfolio

# 請參閱 sim 函數的文件以獲取更多信息
# https://doc.finlab.tw/getting-start/

report_strategy1 = sim(...)
report_strategy2 = sim(...)
report_strategy3 = sim(...)

portfolio = Portfolio({
    'strategy1': (report_strategy1, 0.3),
    'strategy2': (report_strategy2, 0.4),
    'strategy3': (report_strategy3, 0.3),
})

finlab.portfolio.create_multi_asset_report

create_multi_asset_report(stock_list, **kwargs)

根據提供的股票清單創建多資產報告。 Create a multi-asset report based on the stock list provided.

PARAMETER	DESCRIPTION
`stock_list`	一個以股票代號為 key，權重大小為 value。 A dictionary with stock id as key and weight as value. TYPE: `dict`

RETURNS	DESCRIPTION
`Report`	一個包含回測結果的報告對象。A report object with the backtest result.

Example:

>>> from finlab.portfolio import create_multi_asset_report
...
...
>>> report = create_multi_asset_report({'2330': 0.5, '1101': 0.5})

finlab.portfolio.create_report_from_cloud

create_report_from_cloud(strategy_id, user_id=None)

根據提供的用戶ID和策略ID創建在線報告。 Create an online report based on the user id and strategy id provided.

PARAMETER	DESCRIPTION
`user_id`	The user id. TYPE: `str` DEFAULT: `None`
`strategy_id`	The TYPE: `str`

finlab.portfolio.PortfolioSyncManager

PortfolioSyncManager(data=None, start_with_empty=False)

投資組合類別，用於設定和獲取投資組合資訊。

ATTRIBUTE	DESCRIPTION
`path`	投資組合資訊的儲存路徑。 TYPE: `str`

METHOD	DESCRIPTION
`set`	Dict[str, Tuple[int, Report]]): 設定投資組合的函數。
`get_position`	獲取持倉資訊。

Examples:

from finlab.portfolio import Portfolio, PortfolioSyncManager

# 初始化投資組合
port = Portfolio({'策略A': (report1, 0.3), '策略B': (report2, 0.7)})

# 設定投資組合
# pm = PortfolioSyncManager.from_local() or 
# pm = PortfolioSyncManager.from_cloud()
pm = PortfolioSyncManager() 
pm.update(port, total_balance=1000000)
pm.to_cloud() # pm.to_local()

print(pm)

# 下單
account = ... # 請參考 Account 產生方式
pm.sync(account) # 平盤價格下單

建構投資組合。

clear

clear()

清除持倉資訊。

RETURNS	DESCRIPTION
	None

create_order_executor

create_order_executor(account, at='close', consider_margin_as_asset=False, market_name=None, **kwargs)

同步持倉資訊。

PARAMETER	DESCRIPTION
`account`	交易帳戶。 TYPE: `Account`
`consider_margin_as_asset`	是否將融資融券視為資產。預設為 True。 TYPE: `bool` DEFAULT: `False`
`market_name`	指定市場名稱。預設為 None，也就是獲取所有市場。 TYPE: `str` DEFAULT: `None`
`market_order`	以類市價盡量即刻成交：所有買單掛漲停價，所有賣單掛跌停價 TYPE: `bool`
`best_price_limit`	掛芭樂價：所有買單掛跌停價，所有賣單掛漲停價 TYPE: `bool`
`view_only`	預設為 False，會實際下單。若設為 True，不會下單，只會回傳欲執行的委託單資料(dict) TYPE: `bool`
`extra_bid_pct`	以該百分比值乘以價格進行追價下單，如設定為 0.05 時，將以當前價的 +(-)5% 的限價進買入(賣出)，也就是更有機會可以成交，但是成交價格可能不理想；假如設定為 -0.05 時，將以當前價的 -(+)5% 進行買入賣出，也就是限價單將不會立即成交，然而假如成交後，價格比較理想。參數有效範圍為 -0.1 到 0.1 內。 TYPE: `float`

RETURNS	DESCRIPTION
	None

from_cloud `classmethod`

from_cloud(name='default')

從雲端檔案初始化投資組合。

PARAMETER	DESCRIPTION
`path`	雲端檔案的路徑。預設為 'default'。 TYPE: `str`

RETURNS	DESCRIPTION
`PortfolioSyncManager`	投資組合類別。

from_local `classmethod`

from_local(name='default')

從本地檔案初始化投資組合。

PARAMETER	DESCRIPTION
`path`	本地檔案的路徑。 TYPE: `str`

RETURNS	DESCRIPTION
`PortfolioSyncManager`	投資組合類別。

from_path `classmethod`

from_path(path)

從本地檔案初始化投資組合。

PARAMETER	DESCRIPTION
`path`	本地檔案的路徑。 TYPE: `str`

RETURNS	DESCRIPTION
`PortfolioSyncManager`	投資組合類別。

get_position

get_position(at='close', market_name=None)

獲取持倉資訊。

PARAMETER	DESCRIPTION
`market_name`	指定市場名稱。預設為 None，也就是獲取所有市場。 TYPE: `str` DEFAULT: `None`

RETURNS	DESCRIPTION
	dict or Position: 若 combined 為 True，則返回合併後的持倉資訊（Position 物件）；若 combined 為 False，則返回原始持倉資訊（dict）。

get_strategy_position

get_strategy_position(strategy_name, at)

獲取策略的開倉部位。

PARAMETER	DESCRIPTION
`strategy_name`	策略名稱。 TYPE: `str`

RETURNS	DESCRIPTION
`dict`	開倉部位資訊。

margin_cash_position_combine `staticmethod`

margin_cash_position_combine(acp, idp)

合併現金與保證金部位。

PARAMETER	DESCRIPTION
`acp`	當前帳戶的股票部位。 TYPE: `Position`
`idp`	新的帳戶的股票部位。 TYPE: `Position`

sync

sync(account, at='close', consider_margin_as_asset=True, market_name=None, **kwargs)

同步持倉資訊。

PARAMETER	DESCRIPTION
`account`	交易帳戶。 TYPE: `Account`
`consider_margin_as_asset`	是否將保證金交易視為資產。預設為 True。 TYPE: `bool` DEFAULT: `True`
`market_name`	指定市場名稱。預設為 None，也就是獲取所有市場。 TYPE: `str` DEFAULT: `None`
`market_order`	以類市價盡量即刻成交：所有買單掛漲停價，所有賣單掛跌停價 TYPE: `bool`
`best_price_limit`	掛芭樂價：所有買單掛跌停價，所有賣單掛漲停價 TYPE: `bool`
`view_only`	預設為 False，會實際下單。若設為 True，不會下單，只會回傳欲執行的委託單資料(dict) TYPE: `bool`
`extra_bid_pct`	以該百分比值乘以價格進行追價下單，如設定為 0.05 時，將以當前價的 +(-)5% 的限價進買入(賣出)，也就是更有機會可以成交，但是成交價格可能不理想；假如設定為 -0.05 時，將以當前價的 -(+)5% 進行買入賣出，也就是限價單將不會立即成交，然而假如成交後，價格比較理想。參數有效範圍為 -0.1 到 0.1 內。 TYPE: `float`

RETURNS	DESCRIPTION
	None

to_cloud

to_cloud(name='default')

將投資組合資訊存至雲端檔案。

RETURNS	DESCRIPTION
	None

to_local

to_local(name='default')

將投資組合資訊存至本地檔案。

RETURNS	DESCRIPTION
	None

to_path

to_path(path)