ChangeBaseCurrency

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

  • Change base currency for existing account. 

  • Fully Disclosed Client (Individual, Joint, Retirement, Org, Trust)

  • Advisor Client (Individual, Joint, Retirement, Org, Trust)

  • Non-Disclosed- NonQI Client (Individual, Joint, Org, Trust)

  • Non-Disclosed- QI Client with Trading (Individual, Joint, Org, Trust)

  • Non-Disclosed- QI Client with No Trading (Individual, Joint, Org, Trust)

  • Base currency requests will not be effective until the following business day.

Name

Type

Description

reference_account_id

String

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

new_base_currency
AUD DKK ILS NZD TRY
CAD EUR JPY PLN USD

CHF

GBP

KRW

RUB

ZAR

CNH

HKD

MXN

SEK

 AED

CZK

HUF

NOK

SGD

 KRW
SAR TRY      

New base currency for the account.

 

XSD

Copy 
<xsd:complexType name="ChangeBaseCurrency" maxOccurs="1" />
<xsd:sequence>
 <xsd:attribute name="reference_account_id" type="xsd:string" use="required">
 <xsd:attribute name="new_base_currency" type="xsd:basecurrency" " use="required">
</xsd:sequence>

Sample

Copy 
<?xml version="1.0" encoding="us-ascii" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
  <ChangeBaseCurrency reference_account_id="U123222" new_base_currency="USD"/>
</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
ChangeBaseCurrency 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>
   <ChangeBaseCurrency 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>
   <ChangeBaseCurrency reference_account_id="U2088007" request_status="ERROR" request_id="50813">
    <Error>Error Message Here</Error>
  </ChangeBaseCurrency>
</Process>