Skip to main content

FlexReport

ib_interface.api.flexreport

Access to account statement webservice.

FlexError

FlexReport

To obtain a token:

  • Login to web portal
  • Go to Settings
  • Click on "Configure Flex Web Service"
  • Generate token

topics

def topics()

Get the set of topics that can be extracted from this report.

extract

def extract(topic: str, parseNumbers = True) -> list

Extract items of given topic and return as list of objects.

The topic is a string like TradeConfirm, ChangeInDividendAccrual, Order, etc.

df

def df(topic: str, parseNumbers = True)

Same as extract but return the result as a pandas DataFrame.

download

def download(token, queryId)

Download report for the given token and queryId.

load

def load(path)

Load report from XML file.

save

def save(path)

Save report to XML file.