ChangeMarginType

https://[domain]/ws/eca/update

  • Upgrade margin type for existing account. 

  • All customer types.

  • Non-Disclosed: Requests submitted prior to 5pm EST will be processed the following business day.

  • Fully-Disclosed and Advisor Clients: Takes 1-2 business day to be processed and reviewed by our compliance team.

  • Use /getAmRequestStatus to check the status of the request.

  • ChangeMarginType request must be initiated by the client.

  • The account holder must be presented with the required form AND sign the required form before the counterparty submits the request to IBKR.

    • Portfolio Margin

      • 4015: Portfolio Margin Risk Disclosure

      • 1005: Margin Trading Risk Disclosure

    • RegT Margin

      • 1005: Margin Trading Risk Disclosure

Name

Type

Description

reference_account_id

String

IBKR account ID of the advisor/broker client account permissions are being requested for.

new_margin

RegT

REGT

PortfolioMargin

PORTFOLIOMARGIN

Portfolio Margin: Risk Based Model and can offer anywhere from a 6:1 leverage for a diverse portfolio; and down to a 3:1 leverage for a more concentrated portfolio.

Minimum Equity: $100,000

If the account falls below $100,000 the account will be in close only mode.

 

RegT: Rule based margin and offers 4:1 leverage intraday and 2:1 leverage overnight.

 

Minimum Equity: $2,000

 

XSD

Copy 
<xsd:complexType name="ChangeMarginType" maxOccurs="1" />
<xsd:sequence>
 <xsd:attribute name="reference_account_id" type="xsd:string" use="required">
 <xsd:attribute name="new_margin" type="xsd:margin_type" " use="required">
</xsd:sequence>

Sample

Copy
Non-Disclosed Clients
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
    <ChangeMarginType reference_account_id="U0000009" new_margin="MARGIN"/>
</AcctMgmtRequests>
Copy
Fully Disclosed and Advisor Clients Only
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
  <ChangeMarginType reference_account_id="U0000009" new_margin="MARGIN">
  <DocumentSubmission reference_account_id="U0000009">
    <Document form_no="1005" exec_ts="20200208101201" exec_login_ts="20200208101201">
      <SignedBy>John Smith</SignedBy>
        <AttachedFile file_name="Form1005.pdf" file_length="43787" sha1_checksum="646asdf54654"/>
    </Document>
  </DocumentSubmission>
 </ChangeMarginType>
</AcctMgmtRequests>

Name

Type

Description

Execution_Date

YYYY/MM/DD HH:MM:SS

Date/Time which the file was processed by IBKR.

Process_File

FirmName_YYYY-MM-DD_######.xml

File name of the request file.

Client

FirmName

Name of the Counterparty

Client_Master_Acct

String

Master account number
ChangeMarginType String Status of the request
reference_account_id String IBKR account ID of the advisor/broker client account which the request is being submitted for
request_status

PROCESSED

ERROR

PENDING

 Status of the request
message String Status of the request.
request_id Non-negative integer Unique ID which IBKR assigns to the request. The ID can be used to query status request at a later time using //getAmRequestStatus endpoint
message String Includes details on the status of the request IF status=”PENDING" or "PROCESSED "
Pending_Tasks <Tasks> Includes pending tasks associated with the info change request IF status=”PENDING"
Errors String Includes error message if status=”ERROR”

Sample

Copy
Success
<?xml version='1.0' encoding='UTF-8'?>
<Process>
  <Execution ECA_XML_Schema_Version="15-Nov-2018">
    <Execution_Date>2020/02/20 00:44:38</Execution_Date>
    <Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
    <Client>TesterFA</Client>
    <Client_Master_Acct>F1234567</Client_Master_Acct>
  </Execution>
   <ChangeMarginType reference_account_id="U2088007" request_status="PROCESSED" message="Status of the request" request_id="50813"/>
</Process>
Copy
Error
<?xml version='1.0' encoding='UTF-8'?>
<Process>
  <Execution ECA_XML_Schema_Version="15-Nov-2018">
    <Execution_Date>2020/02/20 00:44:38</Execution_Date>
    <Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
    <Client>TesterFA</Client>
    <Client_Master_Acct>F1234567</Client_Master_Acct>
  </Execution>
   <ChangeMarginType reference_account_id="U2088007" request_status="ERROR" request_id="50813">
    <Error>Error Message Here</Error>
  </ChangeMarginType>
</Process>