ib_async.flexreport
Generated from the installed ib_async 2.1.0 package. Signatures and defaults are version-specific.
Access to account statement webservice.
Operational guides
Public constants
| Name | Value |
|---|---|
FLEXREPORT_URL | 'https://ndcdyn.interactivebrokers.com/AccountManagement/FlexWebService/SendRequest?' |
FlexError
FlexError(...)
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexError
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ibkr-docs-flex-error-codes (
inference; retrieved2026-08-13T19:35:39.678892+00:00) - ibkr-docs-flex-error-codes (
official-current; retrieved2026-08-13T19:35:39.678892+00:00) - ibkr-docs-flex-send-request-failure (
official-current; retrieved2026-08-15T12:37:32.085376+00:00) - ibkr-guides-flex-request-overrides (
official-current; retrieved2026-08-15T12:37:46.294168+00:00)
Common base class for all non-exit exceptions.
FlexReport
FlexReport(token=None, queryId=None, path=None)
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexReport
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ibkr-docs-flex-token-configuration (
inference; retrieved2026-07-31T10:03:48.409303+00:00) - ibkr-guides-flex-web-service-configuration (
inference; retrieved2026-07-28T13:00:01.724888Z) - ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z) - ibflex-repository-v1-1 (
library-source; retrieved2026-08-15T12:55:10Z) - ibkr-docs-flex-client-configuration (
official-current; retrieved2026-07-31T10:03:43.185200+00:00) - ibkr-docs-flex-query-identifier (
official-current; retrieved2026-07-31T10:03:54.649207+00:00) - ibkr-docs-flex-token-configuration (
official-current; retrieved2026-07-31T10:03:48.409303+00:00) - ibkr-guides-activity-flex-query-configuration (
official-current; retrieved2026-08-10T14:30:15.827897Z) - ibkr-guides-flex-delivery-general-configuration (
official-current; retrieved2026-08-10T14:30:26.557076Z) - ibkr-guides-flex-queries (
official-current; retrieved2026-07-28T12:59:56.319393Z) - ibkr-guides-flex-web-service-configuration (
official-current; retrieved2026-07-28T13:00:01.724888Z) - ibkr-guides-trade-flex-query-configuration (
official-current; retrieved2026-08-10T14:30:21.177323Z)
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)
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexReport.df
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z)
Same as extract but return the result as a pandas DataFrame.
download
download(self, token, queryId)
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexReport.download
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ib-async-repository-2-1-0 (
inference; retrieved2026-07-15T03:42:42Z) - ibkr-docs-flex-error-codes (
inference; retrieved2026-08-13T19:35:39.678892+00:00) - ibkr-docs-flex-introduction (
inference; retrieved2026-07-31T10:59:11.674514+00:00) - ibkr-docs-flex-send-request-success (
inference; retrieved2026-08-15T12:37:27.775428+00:00) - ibkr-docs-flex-using-service-introduction (
inference; retrieved2026-08-15T12:37:14.695117+00:00) - ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z) - ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z) - ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z) - ibkr-docs-flex-generate-report (
official-current; retrieved2026-08-15T12:37:18.958608+00:00) - ibkr-docs-flex-get-statement (
official-current; retrieved2026-08-15T12:37:40.886988+00:00) - ibkr-docs-flex-introduction (
official-current; retrieved2026-07-31T10:59:11.674514+00:00) - ibkr-docs-flex-retrieve-report (
official-current; retrieved2026-08-15T12:37:36.618446+00:00) - ibkr-docs-flex-send-request (
official-current; retrieved2026-08-15T12:37:23.260013+00:00) - ibkr-docs-flex-send-request-success (
official-current; retrieved2026-08-15T12:37:27.775428+00:00) - ibkr-docs-flex-using-service-introduction (
official-current; retrieved2026-08-15T12:37:14.695117+00:00) - ibkr-guides-flex-request-overrides (
official-current; retrieved2026-08-15T12:37:46.294168+00:00)
Download report for the given token and queryId.
extract
extract(self, topic: str, parseNumbers=True) -> list
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexReport.extract
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ibkr-guides-flex-queries (
inference; retrieved2026-07-28T12:59:56.319393Z) - ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z) - ibkr-guides-activity-flex-query-reference (
official-current; retrieved2026-07-28T13:00:07.112691Z) - ibkr-guides-flex-account-information (
official-current; retrieved2026-08-10T14:30:31.890514Z) - ibkr-guides-flex-model-configuration (
official-current; retrieved2026-08-10T14:30:37.844493Z)
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)
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexReport.get_url
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z)
Generate flexreport URL.
load
load(self, path)
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexReport.load
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z)
Load report from XML file.
save
save(self, path)
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexReport.save
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z)
Save report to XML file.
topics
topics(self)
Completeness: advanced-low-level · Canonical ID: ib_async.flexreport.FlexReport.topics
Advanced or protocol-level surface classified separately from application utilities.
Sources and provenance
- ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z)
Get the set of topics that can be extracted from this report.