investfly.api.PortfolioApiClient

Client for virtual portfolios, broker accounts, positions, and trade orders.

class PortfolioApiClient:

Read portfolio state and submit orders to supported Investfly accounts.

PortfolioApiClient(restApiClient: investfly.api.RestApiClient.RestApiClient)

Create a portfolio client backed by an authenticated transport.

def getPortfolio( self, portfolioId: str, broker: investfly.models.portfolio.Broker) -> investfly.models.portfolio.Portfolio:

Load balances, positions, completed trades, and pending orders for an account.

def getOpenOptionGroups( self, portfolioId: str, broker: investfly.models.portfolio.Broker, deployedStrategyId: int) -> List[investfly.models.portfolio.OptionPositionGroup]:

Return open option position groups owned by a deployed strategy.

def resetVirtualPortfolio(self, portfolioId: str) -> investfly.models.common.Message:

Reset an Investfly virtual portfolio to its configured starting state.

def submitTradeOrder( self, portfolioId: str, broker: investfly.models.portfolio.Broker, order: investfly.models.portfolio.TradeOrder) -> investfly.models.portfolio.OrderStatus:

Submit one stock, ETF, forex, crypto, futures, or option-leg order.

def submitTradeOrders( self, portfolioId: str, broker: investfly.models.portfolio.Broker, orders: List[investfly.models.portfolio.TradeOrder]) -> List[investfly.models.portfolio.OrderStatus]:

Submit a batch of independent trade orders.

def submitOptionPackageOrder( self, portfolioId: str, broker: investfly.models.portfolio.Broker, order: investfly.models.portfolio.OptionPackageOrder) -> List[investfly.models.portfolio.OrderStatus]:

Submit one atomic multi-leg option package where the account supports it.