positions: Positions for All Accounts

In enricoschumann/IButils: Utility Functions for the Interactive Brokers API

Positions for All Accounts

Description

Fetch positions for all accounts.

Usage

positions(port = 7496, clientId = 1,
          contractFields = c("conId", "localSymbol", "currency"),
          verbose = TRUE)

Arguments

port	integer
clientId	integer
contractFields	character; contract information to include, see Examples
verbose	logical

Details

Fetch current positions (possibly for more than one account) for the running TWS session.

Value

A data.frame with columns account, position and avgCost, and contract data specified by argument contractFields.

There are at least two attributes:

CashBalances

a data.frame with columns account, currency and value

Contracts

a list of contracts

Author(s)

Enrico Schumann

References

https://www.interactivebrokers.com/campus/ibkr-api-page/twsapi-doc/

See Also

ib_hist_data

Examples

  ## Functions require an account with Interactive Brokers
  ## and a running TWS.

  positions(port = 7496)

  ## contract data
  if (requireNamespace("rib"))
      names(rib::Contract)
  p <- positions(port = 7496,
                 contractFields = c("conId", "localSymbol", "strike",
                                    "lastTradeDateOrContractMonth"))

  ## show cash holdings
  attr(p, "CashBalances")

  ## get contract details for first position
  p[1, ]
  contract_details(attr(p, "Contracts")[[1]])

enricoschumann/IButils documentation built on Dec. 11, 2024, 3:03 p.m.