InvStatement Class

Properties   Methods   Events   Config Settings   Errors  

The InvStatement class is a single class that supports the SignOn and Investment Statement Download functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

Syntax

class inebank.InvStatement

Remarks

This class adds detailed investment account statement download functionality to your desktop application, or allows your web application to fetch a user's investment statement without having to redirect to another website. All downloads are done using a secure HTTPS Post to send account sign on information to a financial institution. The InvStatement class receives the secure response and parses the response into its properties.

To use the InvStatement class first identify the financial institution by setting the fi_id, fi_organization and fi_url, properties. Next identify the OFX user and application by setting the ofx_user, ofx_password, ofx_app_id and ofx_app_version properties. Next set the broker_id and account_id properties to the appropriate values to identify the account for which you wish to download a statement.

The following properties provide additional control over the request:

Once you have finished setting the properties that describe the statement you wish to download, use the get_statement method to build and transmit the request automatically. When the response returns, the transaction(s) properties will be populated automatically, together with start_date, end_date and any other data the investment statement includes.

The server's response consists of five blocks of information:

• Transactions: a combination of bank transaction detail records and investment transaction detail records. Transactions only within the specified start and stop dates are sent.
• Positions: positions a user has at a brokerage. Each statement response contains a complete set of position records, even if no transactions occurred in the requested statement period for a particular holding.
• Balances: current balances typically reported on an FI statement, such as cash balance or buying power. They can also convey other items of interest, such as current interest rates.
• Open Orders: current open trading orders that a user has at a brokerage.
• Securities: any security referenced in either transactions, positions, or open orders.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

account_id Property

The account number used for the next statement download.

Syntax

def get_account_id() -> str: ...
def set_account_id(value: str) -> None: ...

account_id = property(get_account_id, set_account_id)

Default Value

""

Remarks

This is the account number for which the user wishes to download a statement. This is used during signon. This property is required to be specified when the get_statement method is called and is also included in the server response.

as_of_date Property

Date for returned list of positions.

Syntax

def get_as_of_date() -> str: ...
def set_as_of_date(value: str) -> None: ...

as_of_date = property(get_as_of_date, set_as_of_date)

Default Value

""

Remarks

This property is optional. It must be specified when include_positions property is set to True. If it is not included with the request, the server should return the most current position information available.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

available_cash Property

Cash balance across all sub-accounts.

Syntax

def get_available_cash() -> str: ...

available_cash = property(get_available_cash, None)

Default Value

""

Remarks

This should include sweep funds as well.

This property is always returned with the balance information if such information is requested to be included (include_balances was set to True) in the investment statement download request (when calling the get_statement method).

This property is read-only.

bal_count Property

The number of records in the Bal arrays.

Syntax

def get_bal_count() -> int: ...

bal_count = property(get_bal_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• bal_aggregate
• bal_amount
• bal_description
• bal_name
• bal_type
• bal_type_description

The array indices start at 0 and end at bal_count - 1.

This property is read-only.

bal_aggregate Property

Wrapper for an investment balance.

Syntax

def get_bal_aggregate(bal_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for an investment balance.

This allows an FI to send any number of balances to the user, complete with description and Help text. The intent is to capture the same type of balance information present on the first page of many FI brokerage statements. This aggregate can also be used to send margin call information.

This property is an optional field. When calling the get_statement method, if the server's response does not contain this value, querying the property will return an empty string.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of ofx_version that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The bal_index parameter specifies the index of the item in the array. The size of the array is controlled by the bal_count property.

This property is read-only.

bal_amount Property

The value of the current balance.

Syntax

def get_bal_amount(bal_index: int) -> str: ...

Default Value

""

Remarks

The value of the current balance. Interpretation of this depends on the value of bal_type property:

If a balance list is present in the server response, the bal_amount is always present in the response for each balance listed.

The bal_index parameter specifies the index of the item in the array. The size of the array is controlled by the bal_count property.

This property is read-only.

bal_type Property

The type of balance.

Syntax

def get_bal_type(bal_index: int) -> int: ...

Default Value

0

Remarks

The type of balance. Possible values for balance types and their meanings are as follows:

If a balance list is present in the server response, the bal_type is always present in the response for each balance listed.

The bal_index parameter specifies the index of the item in the array. The size of the array is controlled by the bal_count property.

This property is read-only.

bal_description Property

A description of the current balance.

Syntax

def get_bal_description(bal_index: int) -> str: ...

Default Value

""

Remarks

A description of the current balance. If a balance list is present in the server response, the bal_description is always present in the response for each balance listed.

The bal_index parameter specifies the index of the item in the array. The size of the array is controlled by the bal_count property.

This property is read-only.

bal_name Property

The name for the current balance.

Syntax

def get_bal_name(bal_index: int) -> str: ...

Default Value

""

Remarks

The name for the current balance. If a balance list is present in the server response, the bal_name is always present in the response for each balance listed.

The bal_index parameter specifies the index of the item in the array. The size of the array is controlled by the bal_count property.

This property is read-only.

bal_type_description Property

A description of the balance type.

Syntax

def get_bal_type_description(bal_index: int) -> str: ...

Default Value

""

Remarks

A description of the balance type. This is a string representation of the value returned by the bal_type property.

The corresponding description for each balance type are as follows:

The bal_index parameter specifies the index of the item in the array. The size of the array is controlled by the bal_count property.

This property is read-only.

broker_id Property

Unique identifier for the FI.

Syntax

def get_broker_id() -> str: ...
def set_broker_id(value: str) -> None: ...

broker_id = property(get_broker_id, set_broker_id)

Default Value

""

Remarks

This property holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

It is required to be specified when the get_statement method is called and is also included in the server response.

buying_power Property

Buying power.

Syntax

def get_buying_power() -> str: ...

buying_power = property(get_buying_power, None)

Default Value

""

Remarks

The amount of money available to buy securities. In a margin account, the buying power is the total cash held in the brokerage account plus maximum margin available.

This property is an optional field. When calling the get_statement method, if the server's response does not contain this value, querying the property will return an empty string.

This property is read-only.

closing_detail_count Property

The number of records in the ClosingDetail arrays.

Syntax

def get_closing_detail_count() -> int: ...

closing_detail_count = property(get_closing_detail_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• closing_detail_aggregate
• closing_detail_fitid
• closing_detail_image_ref
• closing_detail_image_ref_type

The array indices start at 0 and end at closing_detail_count - 1.

This property is read-only.

closing_detail_aggregate Property

Aggregates are pieces of XML taken from the financial institution's original response.

Syntax

def get_closing_detail_aggregate(closing_detail_index: int) -> str: ...

Default Value

""

Remarks

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of ofx_version that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

This aggregate describes a statement closing information. It contains data (elements and values) associated with the following properties:

• closing_detail_fitid
• closing_detail_date_start
• closing_detail_date_end
• closing_detail_date_open
• closing_detail_date_close
• closing_detail_date_due (applicable to credit card accounts only)
• closing_detail_balance_opening
• closing_detail_balance_closing
• closing_detail_total_interest (not applicable to credit card accounts)
• closing_detail_total_fees
• closing_detail_total_credit
• closing_detail_total_debit
• closing_detail_credit_limit (applicable to credit card accounts only)
• closing_detail_image_ref
• closing_detail_image_ref_type

For each aggregate returned, clients can retrieve corresponding transactions by using closing_detail_date_start and closing_detail_date_end in a statement download request (when calling GetStatement method).

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_fitid Property

Unique identifier assigned by financial institution to identify this particular statement closing information.

Syntax

def get_closing_detail_fitid(closing_detail_index: int) -> str: ...

Default Value

""

Remarks

Unique identifier assigned by financial institution to identify this particular statement closing information. This id provides a way for the client to distinguish one closing statement from another.

This is always returned in the server response for each statement.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_image_ref Property

Server specified unique identifier for the statement closing image.

Syntax

def get_closing_detail_image_ref(closing_detail_index: int) -> str: ...

Default Value

""

Remarks

Server specified unique identifier for the statement closing image.

This can be either image identifier (to be used during the request to retrieve the actual image when the get_image method is called) or URL, depending on the value of closing_detail_image_ref_type.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_image_ref_type Property

Type of retrieval method for actual statement closing image.

Syntax

def get_closing_detail_image_ref_type(closing_detail_index: int) -> str: ...

Default Value

""

Remarks

Type of retrieval method for actual statement closing image.

If closing_detail_image_ref is returned in the response, this can be either image identifier (to be used during the request for the image when the get_image method is called) or a URL.

Possible values for closing_detail_image_ref_type are:

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

currency_code Property

Default currency code for this statement.

Syntax

def get_currency_code() -> str: ...

currency_code = property(get_currency_code, None)

Default Value

""

Remarks

Indicates how to interpret the monetary amounts in the current statement. This is a 3-character ISO-4217 currency code, such as USD and EUR.

This property is read-only.

end_date Property

End date of requested transaction list.

Syntax

def get_end_date() -> str: ...
def set_end_date(value: str) -> None: ...

end_date = property(get_end_date, set_end_date)

Default Value

""

Remarks

Date range if transactions should be downloaded. This is a string representing the date at which to stop listing transactions on the statement. Use this property and start_date to constrain the list of transactions retrieved when calling get_statement. This property is optional and can be specified when include_transactions property is set to True. If this is empty, today's date will be passed in the request by default.

This is the value that should be sent in the next start_date request to insure that no transactions are missed.

The end_date will be returned in the server's response either with the value provided in the request, or as today's date if an end date was not included in the request.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

fi_id Property

Financial institution identifier.

Syntax

def get_fi_id() -> str: ...
def set_fi_id(value: str) -> None: ...

fi_id = property(get_fi_id, set_fi_id)

Default Value

""

Remarks

fi_id holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

fi_organization Property

Financial institution organization name.

Syntax

def get_fi_organization() -> str: ...
def set_fi_organization(value: str) -> None: ...

fi_organization = property(get_fi_organization, set_fi_organization)

Default Value

""

Remarks

This is the name of the OFX Financial Institution and is used during signon. Each organization has a unique fi_id that must also be used at signon.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

fi_url Property

Financial institution URL.

Syntax

def get_fi_url() -> str: ...
def set_fi_url(value: str) -> None: ...

fi_url = property(get_fi_url, set_fi_url)

Default Value

""

Remarks

This is the URL of the OFX Financial Institution to which the class will signon and fetch data.

image_file_name Property

Filename and location to save the image content of a transaction or statement.

Syntax

def get_image_file_name() -> str: ...
def set_image_file_name(value: str) -> None: ...

image_file_name = property(get_image_file_name, set_image_file_name)

Default Value

""

Remarks

When calling the get_image method, the image content is returned by that method. If you want the image content to be written to disk, you can set the image_file_name to a desired file name without specifying the type. The file type will be set automatically depending on the image type supported by the server. Possible image types are: jpeg, tiff, png, pdf.

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

Note: Image download is available only for OFX version 2.1.1. When this method is called, the ofx_version is automatically set to '211'.

include_balances Property

Specifies whether or not to include balances in the statement download.

Syntax

def get_include_balances() -> bool: ...
def set_include_balances(value: bool) -> None: ...

include_balances = property(get_include_balances, set_include_balances)

Default Value

TRUE

Remarks

This property is required when the get_statement method is called.

include_images Property

Whether the server has to return data for bank transactions or closing statements images.

Syntax

def get_include_images() -> bool: ...
def set_include_images(value: bool) -> None: ...

include_images = property(get_include_images, set_include_images)

Default Value

FALSE

Remarks

If False (default value), the server will not return any image references in the response.

Otherwise, if the FI supports image download service :

• when the get_statement method is called, the server will return the image references for each transaction (e.g., check image).
• when the get_closing_info method is called, the server will return a reference to the statement closing information image.

These references can then be used as parameters when the get_image method is called.

This is optional and supported in OFX 2.1.1 version only (i.e., if this is requested, the ofx_version should be set to '211').

Note: Clients may request images in statement download and/or closing requests in various message sets. But not all FIs support image download. Prior to requesting these images, clients must verify that support exists on the server for image download. This is indicated by the presence of the IMAGEMSGSET aggregate in the profile response, as well as the IMAGEPROF aggregate in the profile response for the specific message set in question.

For instance, if a client wishes to request transaction images in the banking statement download request, the client must verify the presence of IMAGEMSGSET in the profile as well as transaction image support in the IMAGEPROF aggregate in the BANKMSGSET in the profile. Image download requests are allowed only in OFX 2.1.1 in the Banking, Credit Card, Loan and Investments message sets.

To verify whether your FI supports this service, you should check its profile (by calling the GetProfile method in FIProfile class) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

include_open_orders Property

Specifies whether or not to include open orders in the response.

Syntax

def get_include_open_orders() -> bool: ...
def set_include_open_orders(value: bool) -> None: ...

include_open_orders = property(get_include_open_orders, set_include_open_orders)

Default Value

TRUE

Remarks

This property is required when the get_statement method is called.

include_positions Property

Specifies whether or not to include positions in the statement download.

Syntax

def get_include_positions() -> bool: ...
def set_include_positions(value: bool) -> None: ...

include_positions = property(get_include_positions, set_include_positions)

Default Value

TRUE

Remarks

This property is required when the get_statement method is called.

include_transactions Property

Whether to include transactions in the statement download.

Syntax

def get_include_transactions() -> bool: ...
def set_include_transactions(value: bool) -> None: ...

include_transactions = property(get_include_transactions, set_include_transactions)

Default Value

TRUE

Remarks

This property is required when the get_statement method is called.

margin_balance Property

Margin balance.

Syntax

def get_margin_balance() -> str: ...

margin_balance = property(get_margin_balance, None)

Default Value

""

Remarks

A positive balance indicates a positive cash balance, while a negative balance indicates the customer has borrowed funds.

This property is always returned with the balance information if such information is requested to be included (include_balances was set to True) in the investment statement download request (when calling the get_statement method).

This property is read-only.

marketing_info Property

Marketing information (at most one).

Syntax

def get_marketing_info() -> str: ...

marketing_info = property(get_marketing_info, None)

Default Value

""

Remarks

Optional. This information might be returned when the get_statement method is called.

This property is read-only.

ofx_access_key Property

Access key value received after a MFA authentication in a previous signon.

Syntax

def get_ofx_access_key() -> str: ...
def set_ofx_access_key(value: str) -> None: ...

ofx_access_key = property(get_ofx_access_key, set_ofx_access_key)

Default Value

""

Remarks

This might be returned in the server response after a MFA authentication (i.e. MFA challenge question/answer pairs were validated by the server when the send_challenge_answers method in FIProfile class was called).

To prevent servers from needing to authenticate the user in each OFX request, the server may respond to a correct set of challenge answers with a ofx_access_key on the signon response (when the send_challenge_answers method in FIProfile class was called).

The server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the ofx_access_key it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request again (by calling the request_challenge_questions method in FIProfile class). This allows the server to determine the lifetime of the ofx_access_key.

ofx_app_id Property

OFX application identifier.

Syntax

def get_ofx_app_id() -> str: ...
def set_ofx_app_id(value: str) -> None: ...

ofx_app_id = property(get_ofx_app_id, set_ofx_app_id)

Default Value

""

Remarks

This is the unique identifier of the user's OFX application.

ofx_app_version Property

OFX application version.

Syntax

def get_ofx_app_version() -> str: ...
def set_ofx_app_version(value: str) -> None: ...

ofx_app_version = property(get_ofx_app_version, set_ofx_app_version)

Default Value

""

Remarks

This is the version of the user's OFX application.

ofx_password Property

User's password.

Syntax

def get_ofx_password() -> str: ...
def set_ofx_password(value: str) -> None: ...

ofx_password = property(get_ofx_password, set_ofx_password)

Default Value

""

Remarks

This is the password used when signing on to the OFX Financial Institution's service.

ofx_request Property

The current OFX request aggregate.

Syntax

def get_ofx_request() -> str: ...

ofx_request = property(get_ofx_request, None)

Default Value

""

Remarks

Polling ofx_request will cause the class to generate and return an OFX request aggregate.

This property is read-only.

ofx_response Property

The current OFX response aggregate.

Syntax

def get_ofx_response() -> str: ...
def set_ofx_response(value: str) -> None: ...

ofx_response = property(get_ofx_response, set_ofx_response)

Default Value

""

Remarks

This can be used especially for debugging purposes. This can also be used to parse an OFX Response. To do so, you can set the OFX Response data (in string format) to ofx_response. Once set, the supplied OFX data will be parsed and will populate the same read-only properties that read_ofx_data_file does.

ofx_user Property

User's id.

Syntax

def get_ofx_user() -> str: ...
def set_ofx_user(value: str) -> None: ...

ofx_user = property(get_ofx_user, set_ofx_user)

Default Value

""

Remarks

This is the UserID used when signing on to the OFX Financial Institution's service.

ofx_version Property

OFX API version.

Syntax

def get_ofx_version() -> str: ...
def set_ofx_version(value: str) -> None: ...

ofx_version = property(get_ofx_version, set_ofx_version)

Default Value

"102"

Remarks

This is the OFX API version used in all requests sent to your FI server (such as 1.0.2, 2.0.1, 2.1.1, etc.). Valid values: 102, 103, 200, 201, 203, 210, 211. Note that not all OFX Versions are supported by FIs.

Note: If the ofx_version is set to 1x, the request and the response are going to be in SGML format. If set to 2x, the request will be in XML format (the response format depends on the FI's server capabilities). Note that if the OFX FI server does not support version 2x, the server will return an error (such as 'Bad Request').

Certain services are available only for a specific OFX version. For example, image download, is available only in OFX version 2.1.1.

oo_count Property

The number of records in the OO arrays.

Syntax

def get_oo_count() -> int: ...

oo_count = property(get_oo_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• oo_aggregate
• oo_buy_type
• oo_date_placed
• oo_duration
• oofitid
• oo_memo
• oo_restriction
• oo_security_id
• oo_sell_type
• oo_sub_account_type
• oo_type
• oo_type_description
• oo_units
• oo_unit_type

The array indices start at 0 and end at oo_count - 1.

This property is read-only.

oo_aggregate Property

Wrapper for a general open order, each pertaining to a different aggregate type.

Syntax

def get_oo_aggregate(oo_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for a general open order, each pertaining to a different aggregate type.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of ofx_version that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_buy_type Property

Type of purchase for this open order.

Syntax

def get_oo_buy_type(oo_index: int) -> str: ...

Default Value

""

Remarks

Type of purchase for this open order. Possible values are: BUY and BUYTOCOVER (used to close short sales).

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_date_placed Property

Date-time the order was placed.

Syntax

def get_oo_date_placed(oo_index: int) -> str: ...

Default Value

""

Remarks

Date-time the order was placed.

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_duration Property

Indicates how long the open order is good for.

Syntax

def get_oo_duration(oo_index: int) -> str: ...

Default Value

""

Remarks

Indicates how long the open order is good for. The possible values are: DAY, GOODTILCANCEL, IMMEDIATE.

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oofitid Property

Transaction Id assigned by the financial institution.

Syntax

def get_oofitid(oo_index: int) -> str: ...

Default Value

""

Remarks

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_memo Property

Other information about an open order (at most one).

Syntax

def get_oo_memo(oo_index: int) -> str: ...

Default Value

""

Remarks

Other information about an open order (at most one).

This property is an optional field. When calling the get_statement method, if the server's response does not contain this value, querying the property will return an empty string.

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_type Property

Type for general open order aggregate.

Syntax

def get_oo_type(oo_index: int) -> int: ...

Default Value

0

Remarks

Type for general open order aggregate. The open order types and their meanings are as follows:

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_restriction Property

Special restriction on the open order.

Syntax

def get_oo_restriction(oo_index: int) -> str: ...

Default Value

""

Remarks

Special restriction on the open order. The possible values are: ALLORNONE, MINUNITS, NONE.

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_security_id Property

Security ID for this open order.

Syntax

def get_oo_security_id(oo_index: int) -> str: ...

Default Value

""

Remarks

Security ID for this open order.

This property consists of a naming standard followed by a semicolon and a 9-character identifier. The naming standard identifies the method used for assigning the identifier ("CUSIP" in the US) and is unique within the indicated naming standard. This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_sell_type Property

Type of sale.

Syntax

def get_oo_sell_type(oo_index: int) -> str: ...

Default Value

""

Remarks

Type of sale. Possible values are: SELL, SELLSHORT.

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_sub_account_type Property

This identifies the type of a sub-account.

Syntax

def get_oo_sub_account_type(oo_index: int) -> str: ...

Default Value

""

Remarks

This identifies the type of a sub-account.

Many Financial Institutions (FIs) distinguish between activity and positions in cash, margin, and short accounts, with some FIs having many other types of 'sub-accounts'. Open Financial Exchange (OFX) defines four standard sub-account types: CASH, MARGIN, SHORT, and OTHER.

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_type_description Property

A description of the open order type.

Syntax

def get_oo_type_description(oo_index: int) -> str: ...

Default Value

""

Remarks

A description of the open order type. This is a string representation of the value returned by the oooo_type property.

The types and their meanings are as follows:

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_units Property

Quantity of the security the open order is for.

Syntax

def get_oo_units(oo_index: int) -> str: ...

Default Value

""

Remarks

Quantity of the security the open order is for.

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

oo_unit_type Property

What the units represent.

Syntax

def get_oo_unit_type(oo_index: int) -> str: ...

Default Value

""

Remarks

What the units represent. Possible values are: SHARES and CURRENCY.

This property is always returned with the open order information if such an information is requested to be included (include_open_orders was set to True) in the investment statement download request (when calling the get_statement method).

The oo_index parameter specifies the index of the item in the array. The size of the array is controlled by the oo_count property.

This property is read-only.

pos_count Property

The number of records in the Pos arrays.

Syntax

def get_pos_count() -> int: ...

pos_count = property(get_pos_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• pos_account
• pos_aggregate
• pos_date_price_as_of
• pos_market_value
• pos_memo
• pos_option
• pos_security_id
• pos_type
• pos_type_description
• pos_unit_price
• pos_units

The array indices start at 0 and end at pos_count - 1.

This property is read-only.

pos_account Property

Indicates the type of sub-account where the position is held in.

Syntax

def get_pos_account(pos_index: int) -> str: ...

Default Value

""

Remarks

Indicates the type of sub-account where the position is held in. Possible values are: CASH, MARGIN, SHORT, OTHER.

This property is always returned with the positions information if such an information is requested to be included (include_positions was set to True) in the investment statement download request (when calling the get_statement method).

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_aggregate Property

Wrapper for a position information.

Syntax

def get_pos_aggregate(pos_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for a position information.

This aggregate contains properties relevant to all investment position types, as well as those specific to a given position type.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of ofx_version that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_date_price_as_of Property

Date and time of unit price and market value.

Syntax

def get_pos_date_price_as_of(pos_index: int) -> str: ...

Default Value

""

Remarks

Date and time of unit price and market value. Can be 0 if unit price and market value are unknown.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is always returned with the positions information if such an information is requested to be included (include_positions was set to True) in the investment statement download request (when calling the get_statement method).

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_market_value Property

Current market value of this position.

Syntax

def get_pos_market_value(pos_index: int) -> str: ...

Default Value

""

Remarks

Current market value of this position.

This property is always returned with the positions information if such an information is requested to be included (include_positions was set to True) in the investment statement download request (when calling the get_statement method).

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_memo Property

Memo regarding this position.

Syntax

def get_pos_memo(pos_index: int) -> str: ...

Default Value

""

Remarks

Memo regarding this position.

This property is an optional field. When calling the get_statement method, if the server's response does not contain this value, querying the property will return an empty string.

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_option Property

Indicates position type for the given sub-account where this position takes place.

Syntax

def get_pos_option(pos_index: int) -> str: ...

Default Value

""

Remarks

Indicates position type for the given sub-account where this position takes place. Each statement response must contain a complete set of position records, even if no transactions occurred in the requested statement period for a particular holding.

Possible values are: SHORT (Writer for options, Short for all others) and LONG (Holder for options, Long for all others). For options, position type SHORT is equivalent to WRITING an option, and position type LONG is equivalent to HOLDING an option.

For security types where there is only one type (for example, bonds), LONG is used.

This property is always returned with the positions information if such an information is requested to be included (include_positions was set to True) in the investment statement download request (when calling the get_statement method).

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_type Property

Type for general position aggregate.

Syntax

def get_pos_type(pos_index: int) -> int: ...

Default Value

0

Remarks

Type for general position aggregate. The positions types and their meanings are as follows:

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_security_id Property

The security ID for this position.

Syntax

def get_pos_security_id(pos_index: int) -> str: ...

Default Value

""

Remarks

The security ID for this position.

This property consists of a naming standard followed by a semicolon and a 9-character identifier. The naming standard identifies the method used for assigning the identifier ("CUSIP" in the US) and is unique within the indicated naming standard. This property is always returned with the positions information if such an information is requested to be included (include_positions was set to True) in the investment statement download request (when calling the get_statement method).

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_type_description Property

A description of the position type.

Syntax

def get_pos_type_description(pos_index: int) -> str: ...

Default Value

""

Remarks

A description of the position type. This is a string representation of the value returned by the pos_type.

The types and their meanings are as follows:

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_unit_price Property

Unit price.

Syntax

def get_pos_unit_price(pos_index: int) -> str: ...

Default Value

""

Remarks

Unit price. Depending on the type of sub-account where this position takes place, this indicates the following:

This property is always returned with the positions information if such an information is requested to be included (include_positions was set to True) in the investment statement download request (when calling the get_statement method).

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

pos_units Property

Quantity of positions.

Syntax

def get_pos_units(pos_index: int) -> str: ...

Default Value

""

Remarks

Quantity of positions. Depending on the type of sub-account where this position takes place, this indicates the following:

This property is always returned with the positions information if such an information is requested to be included (include_positions was set to True) in the investment statement download request (when calling the get_statement method).

The pos_index parameter specifies the index of the item in the array. The size of the array is controlled by the pos_count property.

This property is read-only.

sec_count Property

The number of records in the Sec arrays.

Syntax

def get_sec_count() -> int: ...

sec_count = property(get_sec_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• sec_aggregate
• sec_asset_class
• sec_fitid
• sec_memo
• sec_name
• sec_security_id
• sec_ticker
• sec_type
• sec_type_description
• sec_unit_price
• sec_yield

The array indices start at 0 and end at sec_count - 1.

This property is read-only.

sec_aggregate Property

Wrapper for security information.

Syntax

def get_sec_aggregate(sec_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for security information.

The value of this property is returned by the server when the investment statement download contains positions, transactions, or open orders.

The sec_aggregate contains information about security referenced in the investment statement download. Clients are completely dependent on the security list to provide descriptive information for the securities referenced in positions, transactions, and open orders.

These aggregates define the type of security, and one or more sets of descriptive information.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of ofx_version that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_asset_class Property

Asset Class for the security (at most one).

Syntax

def get_sec_asset_class(sec_index: int) -> str: ...

Default Value

""

Remarks

Asset Class for the security (at most one). The possible values and their meanings are as follows:

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_fitid Property

Transaction Id assigned by the financial institution.

Syntax

def get_sec_fitid(sec_index: int) -> str: ...

Default Value

""

Remarks

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

This is a character string up to 32 octets long.

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_memo Property

Memo regarding this security.

Syntax

def get_sec_memo(sec_index: int) -> str: ...

Default Value

""

Remarks

Memo regarding this security. This value is optional.

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_name Property

Full name of the security.

Syntax

def get_sec_name(sec_index: int) -> str: ...

Default Value

""

Remarks

Full name of the security. The name can be up to 120 characters long.

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_type Property

The type of security.

Syntax

def get_sec_type(sec_index: int) -> int: ...

Default Value

0

Remarks

The type of security. This is a string representation of the value returned by the sec_type property.

The security types and their meanings are as follows:

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_security_id Property

Security identifier.

Syntax

def get_sec_security_id(sec_index: int) -> str: ...

Default Value

""

Remarks

Security identifier.

This property consists of a naming standard followed by a semicolon and a 9-character identifier. The naming standard identifies the method used for assigning the identifier ("CUSIP" in the US) and is unique within the indicated naming standard.

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_ticker Property

Ticker symbol of the security.

Syntax

def get_sec_ticker(sec_index: int) -> str: ...

Default Value

""

Remarks

Ticker symbol of the security. The value can be up to 32 characters long.

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_type_description Property

A description of the security type.

Syntax

def get_sec_type_description(sec_index: int) -> str: ...

Default Value

""

Remarks

A description of the security type. This is a string representation of the value returned by the sec_type property.

The types and their meanings are as follows:

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_unit_price Property

This is the current unit price of the security as provided by the server.

Syntax

def get_sec_unit_price(sec_index: int) -> str: ...

Default Value

""

Remarks

This is the current unit price of the security as provided by the server. It may be a real-time or delayed quote. The delay amount is determined by the data provider.

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

sec_yield Property

Current yield reported as portion of the fund's assets (at most one).

Syntax

def get_sec_yield(sec_index: int) -> str: ...

Default Value

""

Remarks

Current yield reported as portion of the fund's assets (at most one). This can be returned in the server reply only when sec_type is stMFINFO or stSTOCKINFO.

The sec_index parameter specifies the index of the item in the array. The size of the array is controlled by the sec_count property.

This property is read-only.

short_balance Property

Market value of all short positions.

Syntax

def get_short_balance() -> str: ...

short_balance = property(get_short_balance, None)

Default Value

""

Remarks

This property is always returned with the balance information if such information is requested to be included (include_balances was set to True) in the investment statement download request (when calling the get_statement method).

This property is read-only.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

start_date Property

Start date of requested transaction list.

Syntax

def get_start_date() -> str: ...
def set_start_date(value: str) -> None: ...

start_date = property(get_start_date, set_start_date)

Default Value

""

Remarks

This is a string representing the date at which to start listing transactions on the statement. Use this property and end_date to constrain the list of transactions retrieved when calling get_statement. When provided in the request, start_date value will be echoed in the server's response.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

Note: This property is optional and can be specified when include_transactions property is set to True.

statement_date Property

Date and time for the statement download.

Syntax

def get_statement_date() -> str: ...

statement_date = property(get_statement_date, None)

Default Value

""

Remarks

This property is always returned in the server's response when calling the get_statement method.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

tx_count Property

The number of records in the Tx arrays.

Syntax

def get_tx_count() -> int: ...

tx_count = property(get_tx_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• tx_aggregate
• tx_date
• tx_date_settle
• tx_fitid
• tx_memo
• tx_name
• tx_security_id
• tx_sub_account_fund
• tx_sub_account_sec
• tx_total
• tx_type
• tx_type_description
• tx_unit_price
• tx_units

The array indices start at 0 and end at tx_count - 1.

This property is read-only.

tx_aggregate Property

Wrapper for an investment statement transaction.

Syntax

def get_tx_aggregate(tx_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for an investment statement transaction.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of ofx_version that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_date Property

For other than banking transactions, this is the date when the transaction trade occurred, and for stock splits, this is the day of record stored as a string.

Syntax

def get_tx_date(tx_index: int) -> str: ...

Default Value

""

Remarks

For other than banking transactions, this is the date when the transaction trade occurred, and for stock splits, this is the day of record stored as a string.

For banking transactions, this is the date the transaction was posted to the financial institution.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_date_settle Property

For other than banking transactions, this is the date when settlement occurred, and for stock splits, this is the execution date.

Syntax

def get_tx_date_settle(tx_index: int) -> str: ...

Default Value

""

Remarks

For other than banking transactions, this is the date when settlement occurred, and for stock splits, this is the execution date.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_fitid Property

Transaction Id assigned by the financial institution.

Syntax

def get_tx_fitid(tx_index: int) -> str: ...

Default Value

""

Remarks

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_memo Property

Other information (memo) regarding this transaction.

Syntax

def get_tx_memo(tx_index: int) -> str: ...

Default Value

""

Remarks

Other information (memo) regarding this transaction. The memo property stores a notice from the broker to the customer as a string.

This property is an optional field. When calling the get_statement method, if the server's response does not contain this value, querying the property will return an empty string.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_name Property

Name for this bank transaction.

Syntax

def get_tx_name(tx_index: int) -> str: ...

Default Value

""

Remarks

Name for this bank transaction. When there are bank transactions returned in the statement download (i.e. tx_type returned is ttINVBANKTRAN), the tx_name stores the name of the financial institution or a name assigned by the institution to this transaction, such as 'Customer deposit'.

This property is an optional field. When calling the get_statement method, if the server's response does not contain this value, querying the property will return an empty string.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_security_id Property

Security ID for this investment transaction.

Syntax

def get_tx_security_id(tx_index: int) -> str: ...

Default Value

""

Remarks

Security ID for this investment transaction.

This property consists of a naming standard followed by a semicolon and a 9-character identifier. The naming standard identifies the method used for assigning the identifier ("CUSIP" in the US) and is unique within the indicated naming standard. This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_sub_account_fund Property

The sub-account associated with the funds for the transaction.

Syntax

def get_tx_sub_account_fund(tx_index: int) -> str: ...

Default Value

""

Remarks

The sub-account associated with the funds for the transaction. Where did the money for the transaction come from or go to. The possible values are : CASH, MARGIN, SHORT, OTHER.

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_sub_account_sec Property

Sub-account type for the security.

Syntax

def get_tx_sub_account_sec(tx_index: int) -> str: ...

Default Value

""

Remarks

Sub-account type for the security. The possible values are: CASH, MARGIN, SHORT, OTHER.

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_total Property

Transaction amount.

Syntax

def get_tx_total(tx_index: int) -> str: ...

Default Value

""

Remarks

Transaction amount. For other than banking transactions (buys, sells, etc.) this is the transaction total: ((quantity * (price +/- markup/markdown)) +/- (commission + fees + load + taxes)).

Distributions, interest, margin interest, misc. expense, etc.: amount.

Return of cap: cost basis.

Banking transactions: this is the amount of money exchanged during a given transaction.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_type Property

This is the type of transaction that was made on the account.

Syntax

def get_tx_type(tx_index: int) -> int: ...

Default Value

0

Remarks

This is the type of transaction that was made on the account. Checks, electronic funds transfers, and ATM transactions associated with CMA or money market sweep accounts are always represented with a bank transaction record.

Investment actions that involve securities (buy, sell, stock split, reinvest, etc.) are always represented with an investment record. Actions that are cash-only but are directly associated with a security are also investment actions (for example, dividends).

Other cash-only actions require careful analysis by the FI. Those that affect investment performance analysis should be sent using the appropriate investment action (investment income - miscellaneous, investment expense). Those that are completely unrelated to investment should be sent as a bank record.

The types and their meanings are as follows:

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_type_description Property

A description of the transaction type.

Syntax

def get_tx_type_description(tx_index: int) -> str: ...

Default Value

""

Remarks

A description of the transaction type. This is a string representation of the value returned by the tx_type property.

The types and their meanings are as follows:

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_unit_price Property

Price per commonly-quoted unit, excluding markup/markdown.

Syntax

def get_tx_unit_price(tx_index: int) -> str: ...

Default Value

""

Remarks

Price per commonly-quoted unit, excluding markup/markdown.

It indicates:

• share price for stocks, mutual funds, and others.
• percentage of par for bonds.
• per share (not contract) for options.

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_units Property

The quantity for security-based actions other than stock splits.

Syntax

def get_tx_units(tx_index: int) -> str: ...

Default Value

""

Remarks

The quantity for security-based actions other than stock splits. The tx_units differ for each type of security.

Depending on the type of the security, the tx_units indicates the following:

• Stocks, Mutual Funds and Other : number of shares.
• Bonds : face value. For example, a $25,000 bond trading at $88 would use 25000 as the units and 88 as the unit price.
• Options : number of contracts (not shares).

This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the get_statement method).

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

get_closing_info Method

Download a statement closing information for an investment account.

Syntax

def get_closing_info() -> None: ...

Remarks

This is applicable and supported in OFX 2.1.1 version only (i.e., when this method is called, the ofx_version should be set to '211').

This function generates the Signon and Investment Statement Closing Information request page, submits it to the financial institution via secure HTTPS Post, receives and parses the closing statement information.

The server response includes the FI transaction unique Id and image data information (when available).

The following properties should be set when this method is called:

• fi_id (required)
• fi_organization (required)
• fi_url (required)
• ofx_app_id (required)
• ofx_app_version (required)
• ofx_version (required if 2.x OFX version is the one supported by your FI)
• ofx_user (required)
• ofx_password (required)
• broker_id (required)
• account_id (required)

The client can also specify a date range (by setting the start_date and end_date properties) to limit the number of closing information aggregates that the server returns. If the client does not specify a date range, the server returns as many closing information aggregates as it can (which will be stored in closing_details).

If you want the server to return an image reference for each statement closing information, and if the server supports this service, you will have to set the include_images to True.

The following read-only properties are populated as a result of parsing the statement response:

• currency_code
• closing_details

get_image Method

Request and retrieve a check or statement image (if available).

Syntax

def get_image(image_ref: str, image_ref_type: str) -> bytes: ...

Remarks

This function generates the Signon and Download Image request page, submits it to the financial institution via secure HTTPS Post.

The requested image of a check or statement closing information is identified by ImageRef parameter. The type of this image reference should be specified by ImageRefType parameter.

Possible values and their meanings for the ImageRefType parameter are:

If you want the server to return image references for each transaction or statement closing information, and if the server supports image download service via OFX, you will have to set the include_images to True when either get_statement or get_closing_info method is called.

If available, then you can access that particular image by calling the GetImage method, where ImageRef parameter value is set to the image reference stored in tx_image_ref (or closing_detail_image_ref) and the ImageRefType parameter is set to the respective tx_image_ref_type (or closing_detail_image_ref_type) corresponding to the requested check or statement.

Upon successful response, the image content will be returned by this method. If you want the image to be saved to a file, you can set the image_file_name to a desired name without specifying the type. The file type will be set automatically depending on the image type supported by the server. Possible image types are: jpeg, tiff, png, pdf.

Otherwise, the class will throw an error.

Image download is available only for OFX version 2.1.1. When this method is called, the ofx_version is automatically set to '211'.

Note: Clients may request images in statement download and/or closing requests in various message sets. But not all FIs support image download. Prior to requesting these images, clients must verify that support exists on the server for image download. This is indicated by the presence of the IMAGEMSGSET aggregate in the profile response, as well as the IMAGEPROF aggregate in the profile response for the specific message set in question.

For instance, if a client wishes to request transaction images in the banking statement download request, the client must verify the presence of IMAGEMSGSET in the profile as well as transaction image support in the IMAGEPROF aggregate in the BANKMSGSET in the profile. Image download requests are allowed only in OFX 2.1.1 in the Banking, Credit Card, Loan and Investments message sets.

To verify whether your FI supports this service, you should check its profile (by calling the GetProfile method in FIProfile class) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

get_statement Method

Downloads statement for an investment account.

Syntax

def get_statement() -> None: ...

Remarks

This function generates the Signon and Investment Statement request page, submits it to the financial institution via secure HTTPS Post, receives and parses the investment statement.

This allows a customer to receive investment transactions, positions, open orders, balances and list of securities that are typically part of a regular paper statement. By using the transaction IDs supplied by FIs, OFX makes it possible that each transaction is downloaded only once. Calling of this method requires to designate an account for the download and to indicate what type of data should be downloaded.

The following properties should be set when this method is called:

• fi_id (required)
• fi_organization (required)
• fi_url (required)
• ofx_app_id (required)
• ofx_app_version (required)
• ofx_version (required if 2.x OFX version is the one supported by your FI)
• ofx_user (required)
• ofx_password (required)
• broker_id (required)
• account_id (required)
• include_transactions (required if the user does not want to include bank transactions in the current statement download - True by default)
• include_positions (required if the user does not want to include positions as well in the current statement download - True by default)
• include_open_orders (required if the user does not want to include open orders as well in the current statement download - True by default)
• include_balances (required if the user does not want to include balances as well in the current statement download - True by default)

If the user wants to download investment bank transactions (i.e., include_transactions is set to True), a date range (that the transactions fall within) can be specified by setting the start_date and end_date. Otherwise, the server will use default values if no dates are supplied.

The following information is returned in server's response:

For a full list of all read-only properties that are populated as a result of parsing the statement response, please look at ofx_data_file method remarks.

read_ofx_data_file Method

Reads an OFX response from a file.

Syntax

def read_ofx_data_file(file_name: str) -> None: ...

Remarks

This method reads a previously recorded OFX response from a file, including HTTP and OFX headers.

The following read-only properties are populated as a result of parsing the data file:

• currency_code
• marketing_info
• statement_date
• available_cash
• buying_power
• margin_balance
• short_balance
• balances
• open_orders
• positions
• securities
• transactions
• closing_details

reset Method

Reset the internal state of the class and all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

The Reset method does not have any parameters and does not return any value.

write_ofx_data_file Method

Writes the OFX response sent by the server to a file.

Syntax

def write_ofx_data_file(file_name: str) -> None: ...

Remarks

This method records the entire OFX response, including HTTP and OFX headers to a file. This file can later be read and parsed by the read_ofx_data_file method as though it were a live response.

on_connection_status Event

This event is fired to indicate changes in the connection state.

Syntax

class InvStatementConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class InvStatement:
@property
def on_connection_status() -> Callable[[InvStatementConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[InvStatementConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

on_error Event

Information about errors during data delivery.

Syntax

class InvStatementErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class InvStatement:
@property
def on_error() -> Callable[[InvStatementErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[InvStatementErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class InvStatementSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class InvStatement:
@property
def on_ssl_server_authentication() -> Callable[[InvStatementSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[InvStatementSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class InvStatementSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class InvStatement:
@property
def on_ssl_status() -> Callable[[InvStatementSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[InvStatementSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

InvStatement Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

InvStatement Errors

OFX Errors

	2000   Required field missing from server response.
	2001   OFX server error. Description follows.
	2002   Invalid OFX response.
	2003   OFX response contains unknown element tags.