get_fee_template

https://[domain]/ws/fb/new-request

  • Query active fee template(s) for a specific account(s)

  • Customer Type: Fully Disclosed, Non-Disclosed and Advisor-Clients.

Name Type Description

account_number

String

IBKR account ID of the advisor/broker client account requesting to be reopened. 

id

ID is a unique identifier which you create for each funding request.

  • ID cannot be reused

  • ID must be established in sequential order ie 1, 2, 3, 4  or 100, 101, 102, 103 not 777, 589, 123

  • Max 10 digits for file ID

  • Max 20 digits for counterparty transaction ID

XSD

Copy 
<xsd:complexType name="get_fee_template" maxOccurs="unbounded" >
<xsd:sequence>
 <xsd:element name="account_number" type="string" maxOccurs="1" />
 <xsd:element name="id" type="Non-Negative-Integer " maxOccurs="1" />
</xsd:sequence>

Sample

Copy 
<?xml version="1" encoding="UTF-8"?>
<instruction_set
    xmlns="http://www.interactivebrokers.com/fbfb_instruction_set"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.interactivebrokers.com/fbfb_instruction_set fbfb_instruction_set.xsd "
    creation_date="2019-01-11" id="2" version="1.2">
    <get_fee_template id="2450">
        <account_number>U1234567</account_number>
     </get_fee_template>
</instruction_set>
Name Type Description

creation_date

YYYY-MM-DD

Date/Time which the file was processed by IBKR.

id

Id of the instruction to which this node is a response

 

instr_id

Id of the instruction to which this node is a response

ID is a unique identifier which you create for each funding request.

status

PENDING

PROCESSED

REJECTED

Current status of the instruction associated with the instr_id.

code

String

Error code- (included only if there is an error)

description

String

Description of the error (included only if there is an error)

ib_instr_id

String

ID defined by IBKR.

account_number

String

IBKR account ID of the advisor/broker client account which the fee template was queried for.  

template_name

String

Name of the fee template that is applied to the account.

Sample

Copy 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<instr_result_set xmlns="http://www.interactivebrokers.com/fbfb_result_set"
    id="11112986" version="1.2" creation_date="2022-03-03-05:00">
    <get_fee_template_result>
        <instr_id>11114665</instr_id>
        <status>PROCESSED</status>
        <ib_instr_id>11023533</ib_instr_id>
        <code>FEE_TEMPLATE_NOT_FOUND</code>
        <description>Fee template not found for client account U139838</description>
        <fee_template_details>
            <account_number>U139838</account_number>
            <template_name></template_name>
        </fee_template_details>
    </get_fee_template_result>
</instr_result_set>