Skip to main content

ib_async.flexreport

Generated from the installed ib_async 2.1.0 package. Signatures and defaults are version-specific.

Access to account statement webservice.

Public constants​

NameValue
FLEXREPORT_URL'https://ndcdyn.interactivebrokers.com/AccountManagement/FlexWebService/SendRequest?'

FlexError​

FlexError(...)

Common base class for all non-exit exceptions.

FlexReport​

FlexReport(token=None, queryId=None, path=None)

To obtain a token:

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

df​

df(self, topic: str, parseNumbers=True)

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

download​

download(self, token, queryId)

Download report for the given token and queryId.

extract​

extract(self, 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.

get_url​

get_url(self)

Generate flexreport URL.

load​

load(self, path)

Load report from XML file.

save​

save(self, path)

Save report to XML file.

topics​

topics(self)

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