EmployeeTrack Data Feed Integration GuideCopy Location
Copy Location
Getting Started
This guide provides information for Compliance Officers with EmployeeTrack accounts requesting a 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 accounts, positions, trades and securities, each in a separate file.
The information in this guide pertains to new data feeds NOT listed on the Third-Party Integration page of our website, and to IB in-house data feeds.
This chapter includes the following topics:
Data Feed Integration ProcessCopy Location
Copy Location
Integrating your IB data with third-party software includes the following steps:
- Request a data feed from Interactive Brokers by sending an email to employeetrack@interactivebrokers.com. Include any configuration options with your request.
- Interactive Brokers prepares the requested files.
- The data files are transmitted via FTP/sFTP plus PGP encryption. See Transmitting Files for detailed instructions.
- You integrate the reporting data files with third-party software.
File TypesCopy Location
Copy Location
You can choose to receive any of the following types of data files:
- Accounts – Contains general account information, including Account ID, Title, etc.
- Positions – Contains positions (including cash) as of the report date.
- Transactions – Contains all trade activity.
- Securities – Contains detailed security information for all assets traded or held.
See File Layouts for detailed descriptions of the contents of each type of file.
Requesting a Data FeedCopy Location
Copy Location
To request an EmployeeTrack data feed from Interactive Brokers, you send an email to employeetrack@interactivebrokers.com. Your emailed request must contain the following information:
- Include the text “I would like to integrate my Interactive Brokers EmployeeTrack data with _______.” Fill in the blank with the name of the software vendor.
- The software vendor’s contact information.
- Your Interactive Brokers Account ID.
- The file types you are requesting.
- Delivery information: Tell us how you want the files delivered. IB can host the files on its FTP/sFTP site, can upload them to your FTP/sFTP site, or can make them available for download. Include your PGP Public Key (required). See Transmitting Files for detailed instructions.
- Selected options. See Configuring 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 Christmas Day and New Year’s Day.
File Naming ConventionCopy Location
Copy Location
All reporting data files are text files (*.txt). Regardless of the type of reporting file you choose to receive, the file name follows this convention:
<CompanyAbbreviatedName>_<FileType>_<AsOfDate:yyyyMMdd>.*
where:
- <CompanyAbbreviatedName>Â was set up during your EmployeeTrack account application process.
- <FileType>Â is the type of file: Accounts, Positions, Transactions or Securities.
- <AsOfDate:yyyyMMdd> is the “as of” reporting date, in the format yyyymmdd. This is always the last business day.
File Format: .txt or .csv
ExamplesCopy Location
Copy Location
ABC_ACCT_20220505.txt
or
ABC_ACCT_20220505.csv
This example uses a Company Abbreviated Name of ABC, Accounts as the file type (ACCT), and a reporting date of May 5, 2022 (20220505).
Configuring Data FilesCopy Location
Copy Location
When you request EmployeeTrack 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: Accounts, Positions, Transactions or Securities.
- 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 mm/dd/yyyy but you can specify whatever date format you prefer. For example, you could request that the date format be yyyymmdd.
- Include Column Headers and Header/Trailer Records: Specify whether or not you want column headers and header/trailer records included in the report data files. If requested, they will be included in ALL reporting file types
- Use PGP Encryption: Required. You must provide us with your Public Key.
- Cash Balances – Specify whether or not to include cash balances. This option only applies to position files.
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 FilesCopy Location
Copy Location
Data files can be delivered via FTP/sFTP hosted by Interactive Brokers or FTP/sFTP hosted by the third party software.
If you choose FTP/sFTP, either IB- or third party-hosted:
- IB or third-party will provide FTP host name, username, password, and directory.
PGP encryption is required when using a plain FTP or sFTP. Provide us with your PGP Public Key in your request email.
File LayoutsCopy Location
Copy Location
This chapter describes the layout of each data file. The following topics are included:
- Account File Layout
- Positions File Layout
- Transactions File Layout
- Securities File Layout
- Asset Types
The Version column in the file layout tables indicates the version number when a field first appeared.
Accounts File LayoutCopy Location
Copy Location
Header Record
Column | Type | Version | Comments |
---|---|---|---|
Line Discriminator | Character | Any (If header is enabled) | Value will be “H” |
File Type | Alphanumeric | Accounts | |
File Type Abbreviation | Alphanumeric | ACCT | |
Run Date | Alphanumeric | Date format is configurable | |
Run Time | Alphanumeric | HH:MM:DD in 24 hour format System Clock Time | |
As of Date | Alphanumeric | Data On Record As-Of Date (date format is configurable) | |
Version | Numeric | Version of the file layout used. |
Accounts Record
Column | Type | Version | Column Header | Comments |
---|---|---|---|---|
Line Discriminator | Character | Any (If header is enabled) | C | Value will be “D” for data |
Account ID | Alphanumeric | 1.0 | AccountID | Account number |
Broker | Alphanumeric | 1.0 | Broker | Broker Name. For example, INTERACTIVE BROKERS |
Employee Reference ID | Alphanumeric | 1.0 | EmployeeReferenceID | Optional field internal ID populated by Compliance Officer |
Account Title | Alphanumeric | 1.0 | AccountTitle | Full account title |
Account Type | Alphanumeric | 1.0 | AccountType | Account Type |
Comments | Empty | 1.0 | Comments | Field will be empty |
Street | Alphanumeric | 1.3 | Street | Street address |
Street2 | Alphanumeric | 1.3 | Street2 | Additional street address |
City | Alphanumeric | 1.3 | City | City |
State | Alphanumeric | 1.3 | State | State |
Postal Code | Alphanumeric | 1.3 | PostalCode | Postal code |
Country | Alphanumeric | 1.3 | Country | Country |
DateOpened | Alphanumeric | 1.3 | DateOpened | Date account was opened – MM/DD/YYYY |
DateFunded | Alphanumeric | 1.8 | DateFunded | Date account was funded- MM/DD/YYYY |
Employee Relationship | Alphanumeric | 1.3 | EmployeeRelationship | |
Customer Type | Alphanumeric | 1.3 | CustomerType | |
Date Linked | Alphanumeric | 1.3 | DateLinked | MM/DD/YYYY |
Crypto | Alphanumeric | 1.8 | Crypto | Values will be T or F |
Trailer Record
Column | Type | Version | Comments |
---|---|---|---|
Line Discriminator | Character | 1.5 (if footer is enabled) | Value will be “T” |
File Type | Alphanumeric | Accounts | |
File Type Abbreviation | Alphanumeric | ACCT | |
Data Record Count | Numeric | The number of records between header and trailer. |
Transaction File LayoutCopy Location
Copy Location
Header Record
Column | Type | Version | Comments |
---|---|---|---|
Line Discriminator | Character | Any (If header is enabled) | Value will be “H” |
File Type | Alphanumeric | Transactions | |
File Type Abbreviation | Alphanumeric | CONF | |
Run Date | Alphanumeric | Date format is configurable | |
Run Time | Alphanumeric | HH:MM:DD in 24 hour format System Clock Time | |
As of Date | Alphanumeric | Data On Record As-Of Date (date format is configurable) | |
Version | Numeric | Version of the file layout used. |
Transaction Record
Column | Type | Version | Column Header | Comments |
---|---|---|---|---|
Line Discriminator | Character | Any (If header is enabled) | C | Value will be “D” for data |
Account ID | Alphanumeric | 1.0 | AccountID | Account number |
Broker | Alphanumeric | 1.0 | Broker | Broker Name. For example, INTERACTIVE BROKERS |
Asset Type | Alphanumeric | 1.0 | AssetType | For more information, see Asset Types |
Currency | Alphanumeric | 1.0 | Currency | The currency of the asset |
Symbol | Alphanumeric | 1.0 | Symbol | The ticker symbol of the security |
Security Description | Alphanumeric | 1.0 | SecurityDescription | Description of the security |
CUSIP | Alphanumeric | 1.0 | CUSIP | Will populate only for US securities |
ISIN | Alphanumeric | 1.0 | ISIN | Will populate only for non-US securities |
Transaction Type | Numeric | 1.0 | TransactionType | Buy,Sell, BuyToCover, ShortSell, Dividend Reinvestment (DR), CORP |
Exchange | Numeric | 1.0 | Exchange | Exchange that the trade executed on |
Trade Date | Alphanumeric | 1.0 | TradeDate | MM/DD/YY YY (In time zone setup in account settings (DB)) |
Trade Time | Alphanumeric | 1.0 | TradeTime | HH:MM:SS in 24 hour format System (In time zone setup in account settings (DB)) – Option to include TimeZone (If yes, field will include: HH:mm:ss TimeZone) |
Order Time | Alphanumeric | 1.8 | OrderTime | MM/DD/YY;HH:mm:ss |
Settle Date | Alphanumeric | 1.0 | SettleDate | MM/DD/YY YY |
Quantity | Numeric | 1.0 | Quantity | Quantity of the trade. Note the following regarding sign: If buy 100: 100 If sell 100: -100 If cancel buy: -100 If cancel sell: 100 |
Trade Price | Numeric | 1.0 | TradePrice | Unit price of the security |
Gross Amount | Alphanumeric | 1.8 | Gross Amount | Quantity*Price*Multiplier |
Commission | Numeric | 1.0 | Commission | Negative amount indicates commission charged. Positive amount indicates commission rebate. For Forex trades, the commission is reported in base currency. |
Other Fees | Numeric | 1.0 | OtherFees | Tax, if applicable |
Net Amount | Numeric | 1.0 | NetAmount | Total cash received or delivered. |
Cancel Flag | Alphanumeric | 1.0 | CancelFlag | Y if the trade has been canceled; N if the trade has not been canceled |
Correct Flag | Alphanumeric | 1.0 | CorrectFlag | Y if the trade has been changed; N if the trade has not been changed Note: Limited to 1.0-1.71 |
Flag | Alphanumeric | 1.8 | Flag | Will populate for Corporate Actions |
Trade ID | Alphanumeric | 1.0 | TradeID | |
Related Trade ID | Alphanumeric | 1.0 | RelatedTradeID | Original TradeID for canceled or corrected trade |
Order ID | Numeric | 1.3 | OrderID | |
Related Order ID | Numeric | 1.3 | RelatedOrderID | Original Order ID |
Report Date | Alphanumeric | 1.0 | ReportDate | MM/DD/YYYY |
Comments | Alphanumeric | 1.0 | Comments | Exercised, Expired, Assigned, or Gross EA |
Multiplier | Numeric | 1.1 | Multiplier | |
BBG Ticker | Alphanumeric | 1.2 | BBGTicker | Bloomberg ticker |
BBG Ticker and Exchange Code | Alphanumeric | 1.2 | BBGTickerAnd ExchangeCode | Bloomberg ticker + exchange code |
Bloomberg Global ID | Alphanumeric | 1.4 | BloombergGlobalID | Bloomberg Global ID |
BBG Unique ID | Alphanumeric | 1.7 | BBGUniqueID | |
Underlying BBG Unique ID | Alphanumeric | 1.7 | UnderlyingBBGUniqueID | |
BB Exchange Code | Alphanumeric | 1.7 | BBExchangeCode | |
Underlying Symbol | Alphanumeric | 1.2 | UnderlyingSymbol | |
Underlying Security ID | Alphanumeric | 1.6 | UnderlyingSecurityID | |
Order Type | Alphanumeric | 1.8 | OrderType | |
Action ID | Alphanumeric | 1.8 | ActionID |
Trailer Record
Column | Type | Version | Comments |
---|---|---|---|
Line Discriminator | Character | 1.5 (if footer is enabled) | Value will be “T” |
File Type | Alphanumeric | Accounts | |
File Type Abbreviation | Alphanumeric | ACCT | |
Data Record Count | Numeric | The number of records between header and trailer. |
Positions File LayoutCopy Location
Copy Location
Header Record
Column | Type | Version | Comments |
---|---|---|---|
Line Discriminator | Character | Any (If header is enabled) | Value will be “H” |
File Type | Alphanumeric | Positions | |
File Type Abbreviation | Alphanumeric | POS | |
Run Date | Alphanumeric | Date format is configurable | |
Run Time | Alphanumeric | HH:MM:DD in 24 hour format System Clock Time | |
As of Date | Alphanumeric | Data On Record As-Of Date (date format is configurable) | |
Version | Numeric | Version of the file layout used. |
Positions Record
Column | Type | Version | Column Header | Comments |
---|---|---|---|---|
Line Discriminator | Character | Any (If header is enabled) | C | Value will be “D” for data |
Account ID | Alphanumeric | 1.0 | AccountID | Account number |
Broker | Alphanumeric | 1.0 | Broker | Broker Name. For example, INTERACTIVE BROKERS |
Asset Type | Alphanumeric | 1.0 | AssetType | For more information, see Asset Types |
Currency | Alphanumeric | 1.0 | Currency | The currency of the asset |
Symbol | Alphanumeric | 1.0 | Symbol | The ticker symbol of the security |
Security Description | Empty | 1.0 | SecurityDescription | Description of the security |
CUSIP | Alphanumeric | 1.0 | CUSIP | Will populate only for US securities |
ISIN | Alphanumeric | 1.0 | ISIN | Will populate only for non-US securities |
Quantity | Numeric | 1.0 | Quantity | Positive quantity indicates a long position; Negative quantity indicates a short position |
Market Price | Numeric | 1.0 | MarketPrice | Current market price in local currency |
Market Value | Numeric | 1.0 | MarketValue | Current market value in local currency |
Report Date | Alphanumeric | 1.0 | ReportDate | MM/DD/YYYY |
Comments | Empty | 1.0 | Comments | Field will be empty |
Multiplier | Numeric | 1.1 | Multiplier | |
BBG Ticker | Alphanumeric | 1.2 | BBGTicker | Bloomberg ticker |
BBG Ticker and Exchange Code | Alphanumeric | 1.2 | BBGTickerAnd ExchangeCode | Bloomberg ticker + exchange code |
Bloomberg Global ID | Alphanumeric | 1.4 | BloombergGlobalID | Bloomberg Global ID |
BBG Unique ID | Alphanumeric | 1.7 | BBGUniqueID | |
Underlying BBG Unique ID | Alphanumeric | 1.7 | UnderlyingBBGUniqueID | |
BB Exchange Code | Alphanumeric | 1.7 | BBExchangeCode | |
Underlying Symbol | Alphanumeric | 1.2 | UnderlyingSymbol | |
Underlying Security ID | Alphanumeric | 1.6 | UnderlyingSecurityID |
Trailer Record
Column | Type | Version | Comments |
---|---|---|---|
Line Discriminator | Character | 1.5 (if footer is enabled) | Value will be “T” |
File Type | Alphanumeric | Accounts | |
File Type Abbreviation | Alphanumeric | ACCT | |
Data Record Count | Numeric | The number of records between header and trailer. |
Securities File LayoutCopy Location
Copy Location
Header Record
Column | Type | Version | Comments |
---|---|---|---|
Line Discriminator | Character | Any (If header is enabled) | Value will be “H” |
File Type | Alphanumeric | Securities | |
File Type Abbreviation | Alphanumeric | SEC | |
Run Date | Alphanumeric | Date format is configurable | |
Run Time | Alphanumeric | HH:MM:DD in 24 hour format System Clock Time | |
As of Date | Alphanumeric | Data On Record As-Of Date (date format is configurable) | |
Version | Numeric | Version of the file layout used. |
Security Record
Column | Type | Version | Column Header | Comments |
---|---|---|---|---|
Line Discriminator | Character | Any (If header is enabled) | C | Value will be “D” for data |
Internal Asset ID | Alphanumeric | 1.0 | InternalAssetID | Internal unique identifier for all asset types |
Asset Type | Alphanumeric | 1.0 | AssetType | For more information, see Asset Types |
Security ID | Alphanumeric | 1.0 | SecurityID | US Security – CUSIP Foreign security – ISIN Only for applicable securities |
Symbol | Alphanumeric | 1.0 | Symbol | The ticker symbol of the security |
BBG Ticker | Alphanumeric | 1.2 | BBGTicker | Bloomberg ticker |
BBG Ticker and Exchange Code | Alphanumeric | 1.2 | BBGTickerAnd ExchangeCode | Bloomberg ticker + exchange code |
Bloomberg Global ID | Alphanumeric | 1.4 | BloombergGlobalID | Bloomberg Global ID |
BBG Unique ID | Alphanumeric | 1.7 | BBGUniqueID | |
Underlying BBG Unique ID | Alphanumeric | 1.7 | UnderlyingBBGUniqueID | |
BB Exchange Code | Alphanumeric | 1.7 | BBExchangeCode | |
Description | Alphanumeric | 1.0 | SecurityDescription | Description of the security |
Underlying Symbol | Alphanumeric | 1.2 | UnderlyingSymbol | |
Multiplier | Alphanumeric | 1.0 | Multiplier | |
Expiration Date | Alphanumeric | 1.0 | ExpirationDate | |
Option Type | Alphanumeric | 1.0 | OptionType | |
Option Strike | Alphanumeric | 1.0 | OptionStrike | |
Maturity Date | Alphanumeric | 1.0 | MaturityDate | |
Issue Date | Alphanumeric | 1.0 | IssueDate | |
Underlying Security ID | Alphanumeric | 1.6 | UnderlyingSecurityID | |
Sub Category | Alphanumeric | 1.8 | SubCategory |
Trailer Record
Column | Type | Version | Comments |
---|---|---|---|
Line Discriminator | Character | 1.5 (if footer is enabled) | Value will be “T” |
File Type | Alphanumeric | Accounts | |
File Type Abbreviation | Alphanumeric | ACCT | |
Data Record Count | Numeric | The number of records between header and trailer. |
Asset TypesCopy Location
Copy Location
The following table lists all of the asset types referenced in the Positions, Transactions and Securities file layouts.
Code | Version | Description |
---|---|---|
BILL | 1.0 | Treasury Bills |
BOND | 1.0 | Bonds (includes corporate and municipal) |
CASH | 1.0 | Forex |
CMDTY | 1.0 | Metals |
CRYPTO | 1.0 | Cryptocurrency |
FOP | 1.0 | Future Options |
FSFOP | 1.0 | Options on Futures (Futures Style) |
FSOPT | 1.0 | Options (Futures Style) |
FUND | 1.0 | Mutual Funds |
FUT | 1.0 | Futures |
FXCFD | 1.0 | Contract for Difference on forex |
IOPT | 1.0 | Structured Products |
OPT | 1.0 | Equity and Index Options |
STK | 1.0 | Stocks (includes ADR, ETF) |
WAR | 1.0 | Warrants |