tariochbctools.importers.ibkr package

Submodules

tariochbctools.importers.ibkr.importer module

class tariochbctools.importers.ibkr.importer.Importer[source]

Bases: ImporterProtocol

An importer for Interactive Broker using the flex query service.

createBuy(date: date, account: str, asset: str, quantity: Decimal, currency: str, price: Decimal, commission: Amount, netCash: Amount, baseCcy: str, fxRateToBase: Decimal)[source]
createDividen(payout: Decimal, withholding: Decimal, asset: str, currency: str, date: date, priceLookup: PriceLookup, description: str, account: str)[source]
extract(file, existing_entries)[source]

Extract transactions from a file.

If the importer would like to flag a returned transaction as a known duplicate, it may opt to set the special flag “__duplicate__” to True, and the transaction should be treated as a duplicate by the extraction code. This is a way to let the importer use particular information about previously imported transactions in order to flag them as duplicates. For example, if an importer has a way to get a persistent unique id for each of the imported transactions. (See this discussion for context: https://groups.google.com/d/msg/beancount/0iV-ipBJb8g/-uk4wsH2AgAJ)

Parameters:

  • file – A cache.FileMemo instance.

  • existing_entries – An optional list of existing directives loaded from the ledger which is intended to contain the extracted entries. This is only provided if the user provides them via a flag in the extractor program.

Returns:

A list of new, imported directives (usually mostly Transactions) extracted from the file.

file_account(file)[source]

Return an account associated with the given file.

Note: If you don’t implement this method you won’t be able to move the files into its preservation hierarchy; the bean-file command won’t work.

Also, normally the returned account is not a function of the input file–just of the importer–but it is provided anyhow.

Parameters:

file – A cache.FileMemo instance.

Returns:

The name of the account that corresponds to this importer.

getAssetAccount(account: str, asset: str)[source]
getFeeAccount(account: str)[source]
getIncomeAccount(account: str)[source]
getLiquidityAccount(account: str, currency: str)[source]
getReceivableAccount(account: str)[source]
identify(file)[source]

Return true if this importer matches the given file.

Parameters:

file – A cache.FileMemo instance.

Returns:

A boolean, true if this importer can handle this file.

matches(trx, t, account)[source]

Module contents