Reporting Integration

Interactive Brokers Reporting Integration Tool Guide

Copy Location

This guide provides information for Interactive Brokers clients requesting a reporting data feed from the IBKR generic reporting interface for purposes of integrating that data with third-party software. We provide, on request, reporting data for the following, each in a separate file:

Reporting Integration Process

Copy Location

Integrating your IB reporting data with third-party software includes the following steps:

• Request a reporting data feed from Interactive Brokers by sending an email to reportingintegration@interactivebrokers.com.
• Interactive Brokers prepares the requested files.
• The data files are transmitted to the customer via FTP. See Transmitting Files for detailed instructions.
• You integrate the reporting data files with third-party software.

Reporting File Types

Copy Location

You can choose to receive any of the following types of reporting files.

Start of day (SOD) reporting file types:

• Account – Contains general account information, including Account ID, Title, etc.
• Activity – Contains all trade activity, transfers, dividends, etc. as of the report date.
• Cash Report – Contains cash balances in total, and for the securities and futures segments of your account.
• NAV Report – Contains the Net Asset Value (NAV) of all positions by asset class (stock, securities options, warrants and bonds), cash and accruals.
• P&L  – Contains mark-to-mark and short-term (ST) and long-term (LT) realized and unrealized profit and loss information for your account.
• Positions – Contains positions (including cash and accrual balances) as of the report date.
• Securities – Contains detailed security information for all assets traded or held.

End of day (EOD) reporting file types:

• Trade Confirms – Contains trade activity.

See File Layouts for detailed descriptions of the contents of each type of file.

Requesting a Reporting Data Feed

Copy Location

When you request a reporting data feed from Interactive Brokers, your email must contain the following information:

• Include the text “I would like to integrate my Interactive Brokers reporting data with _______.” Fill in the blank with the name of the software vendor.
• The software vendor’s contact information.
• Your Interactive Brokers Account ID.
  If you are a Master Account User (for example, a Financial Advisor), include the Account IDs of all of the client and/or sub accounts for which you would like reporting data.
• The Reporting File Types you are requesting.
• Delivery information: Tell us how you want the files delivered. IB can host the files on our FTP/sFTP site, can upload them to your FTP/sFTP site, or can make them available for download. Include your PGP Public Key for file encryption. See Transmitting Files for detailed instructions.
• Selected options. See Configuring Reporting Data Files for detailed instructions.

Note that the date of the reporting data is always the last business day. Typically there is no data available for New Year’s Day.

File Naming Convention

Copy Location

By default, all reporting data files are text files (*.txt). You can use a different file name extension (for example, *.csv) as long as you include it with your configuration options. Regardless of the type of reporting file you choose to receive, the file name follows this convention:

<AccountID>_<FileType>_<AsOfDate:yyyyMMdd>.txt

where:

• <AccountID> is your Interactive Brokers Account ID. This can be replaced by a Third-Party Account Reference, if provided. See Configuring Reporting Data Files for more information on including a Third-Party Account Reference.
• <FileType> is the type of reporting file: Account, Activity, Positions, or Securities.
• <AsOfDate:yyyyMMdd> is the “as of” reporting date, in the format yyyymmdd. This is always the last business day.

Examples

Copy Location

U000000_Activity_20100317.txt

This example uses an IB Account ID (U000000), Activity as the file type, and a reporting date of March 17, 2010 (20100317).

XYZCorp_Bookkeeping_20100317.txt

This example uses a Third Party Account Reference (“XYZCorp”) instead of your IB Account ID, a custom value of “Bookkeeping” for the file type (instead of Activity), and a reporting date of March 17, 2010 (20100317)

Configuring Reporting Data Files

Copy Location

When you request IB reporting data, you can configure the features listed below. You must include your configuration options in your request email so that we can create the files correctly.

• File Type: You can choose one or more of these file types: Account, Activity, Cash Report, NAV, P&L, Positions, Securities, and Trade Confirms.
  If you choose the Activity file, you can also include summarized trade data. You can summarize trade data by symbol – for each symbol, there will be one record for buys and one record for sells, if applicable. For advisors and brokers, client fees are also summarized at the account level.
• If you choose the Positions file, you can choose additional levels of detail called Tax Lots and/or Open Dividend Accruals.
• Preferred Version – This is the version of the report fields. The default is 1.0. As we update our report fields, the Version will also be updated (for example, 1.0 will be updated to 1.1).
• Field Delimiter – Specify pipe or comma. If a data field contains a delimiter character, the data will be wrapped in double quotes. This option is required.
• Date Format – Indicates how dates will appear in the report data. The default date format is yyyymmdd but you can specify whatever date format you prefer. For example, you could request that the date format be mmddyyyy.
• Number Format – Indicates how numbers will appear in the report data. The default number format is ###0.#########.
• Third Party Account Reference – If you provide this information, it will be used in the file names and header records instead of your IB Account ID. This option is not required.
• Include Header/Trailer Records – Specify whether or not you want header and trailer records included in the report data. If you want header and trailer records, they will be included in ALL reporting file types.
• Include Column Header – Specify whether or not you want column headers included in the report data files.
• Use PGP Encryption for FTP/sFTP- Required for the reporting data files. You must provide IBKR with your Public Key and files will be encrypted using the key.
• File name extension – Specify the file name extension of your data files. For example, *.csv. The default value is *.txt.

You do not have to request all of the above configuration options. The default value will be used for any configuration option you do not request.

Use line feed (LF) as the end-of-line character.

Transmitting Files

Copy Location

Report data files can be delivered via FTP or sFTP (or Web Service is alternatively available), options outlined below:

• IBKR hosted Plain FTP (port 21 with PGP encryption)
  • IB will provide host, username, password.
  • You will provide IB with a PGP public key.
• IB hosted sFTP (port 22 with PGP encryption)- uses key-based authentication
  • IB will provide host, username, and directory
  • You will provide IB with RSA key for key-based authentication and IP address(es) you will be connecting from.
• Third-party hosted Plain FTP (port 21 with PGP encryption)
  • You will provide host, username, password, directory.
  • You will provide IB with PGP public key.
• Third-Party hosted sFTP (with PGP encryption). You will provide IBKR with-
  • Host, username, directory, port.
  • IB will provide RSA key (for key-based authentication) and IP address to white-list.
• Web Service
  • We will provide additional details via email.

Tell us in your request email to reportingintegration@interactivebrokers.com your delivery preference and we will assist with setting up the configuration.

If you request delivery of report data files as downloadable files, the files will be available from the Activity Downloads page, which you access from the Third-Party Reports menu in Client Portal.

File Layouts

Copy Location

This chapter describes the layout of each reporting file. The following topics are included:

Start of day (SOD):

• Account File Layout
• Activity File Layout
• Cash Report File Layout
• NAV File Layout
• P&L File Layout
• Positions File Layout
• Security File Layout

End of day (EOD):

• Trade Confirms Layout

The Version column in the file layout tables indicates the version number when a field first appeared.

See Sample Files in the next chapter for samples of reporting files.

Account File Layout

Copy Location

Some items in the Account file layout are identified as configurable. For more information about configuring these items, see Configuring Reporting Data Files.

Header Record

Account Record

Trailer Record

Activity File Layout

Copy Location

Some items in the Activity file layout are identified as configurable. For more information about configuring these items, see Configuring Reporting Data Files.

Header Record

Activity Record

Trailer Record

Position File Layout

Copy Location

Some items in the Positions file layout are identified as configurable. For more information about configuring these items, see Configuring Reporting Data Files.

Header Record

Position Record

Trailer Record

NAV File Layout

Copy Location

Some items in the Activity file layout are identified as configurable. For more information about configuring these items, see Configuring Reporting Data Files.

Header Record

NAV Record

Trailer Record

P&L File Layout

Copy Location

This optional file includes mark-to-mark and short-term (ST) and long-term (LT) realized and unrealized profit and loss information for your account.

Header Record

PL Record

Trailer Record

Security File Layout

Copy Location

Some items in the Security file layout are identified as configurable. For more information about configuring these items, see Configuring Reporting Data Files.

Header Record

Security Record

Trailer Record

Trade Confirms File Layout

Copy Location

Some items in the Activity file layout are identified as configurable. For more information about configuring these items, see Configuring Reporting Data Files.

Header Record

Activity Record

Trailer Record

Sample Files

Copy Location

Please reach out to reportingintegration@interactivebrokers.com to request the latest sample files.