CAElectRequest
https://[domain]/ws/cacapi.ext/submit
-
Submit election(s) on voluntary corporate action(s).
Request Parameters
XSD
Copy
<xsd:complexType name="CAElectRequest" >
<xsd:element name="CAElection" type="CAElection" minOccurs="1" maxOccurs="10"/>
<xsd:attribute name="lang" type="xsd:string" use="optional"/>
</xsd:complexType>
</xsd:element>
<xsd:complexType name="CAElection">
<xsd:element name="Election" type="Election" minOccurs="0" maxOccurs="unbounded"/>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="ibCAId" type="xsd:long" use="required"/>
</xsd:complexType>
<xsd:complexType name="Election">
<xsd:attribute name="choiceNum" type="xsd:integer" use="required"/>
<xsd:attribute name="qty" type="xsd:long" use="required"/>
<xsd:attribute name="bidPrice" type="xsd:double" use="optional"/>
</xsd:complexType>Attributes
|
Name |
Type |
Description |
|---|---|---|
|
ibCAId |
String |
ID associated with the corporate action election. |
|
accountId |
String |
IBKR Account ID. If subAccountsChoice is SPECIFIED, include comma separated list of account Ids. |
|
choiceNum |
Integer |
Client election for the corporate action. A voluntary CA will allow the client to choose between different choices identified by this number. |
|
qty |
Long |
Position size.
|
|
bidPrice |
Decimal |
Certain action types have a bid price as part of the election process. |
|
lang |
DE ES IT RU JA FR SN TW |
Language in which the CA description should be shown. Only supported for mandatory actions. DE = German ES = Spanish IT = Italian RU = Russian JA = Japanese FR = French CN = Chinese Simplified TW = Traditional Chinese |
Sample
Copy
Single Request
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CAElectRequest xmlns="http://www.cstools.interactivebrokers.com">
<CAElection accountId="DU150462" ibCAId="65607323">
<Election choiceNum="2" qty="46" />
<Election choiceNum="3" qty="54" bidPrice="67.5"/>
</CAElection>
</CAElectRequest>Copy
Multiple
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CAElectRequest xmlns="http://www.cstools.interactivebrokers.com">
<CAElection accountId="DU150462" ibCAId="65607323">
<Election choiceNum="2" qty="46" />
<Election choiceNum="3" qty="54" bidPrice="67.5"/>
</CAElection>
<CAElection accountId="DU12345" ibCAId="65607323">
<Election choiceNum="2" qty="456" />
<Election choiceNum="3" qty="786" bidPrice="67"/>
</CAElection>
<CAElection accountId="DU150462" ibCAId="123">
<Election choiceNum="2" qty="46" />
<Election choiceNum="3" qty="54" bidPrice="67.5"/>
</CAElection>
<CAElection accountId="DU12345" ibCAId="456">
<Election choiceNum="2" qty="46" />
<Election choiceNum="3" qty="54" bidPrice="67.5"/>
</CAElection>
<CAElection accountId="DU150462" ibCAId="65607324">
<Election choiceNum="2" qty="46" />
<Election choiceNum="3" qty="54" bidPrice="67.5"/>
</CAElection>
</CAElectRequest>Sample
Copy
Single Request
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CAElectResponse xmlns="http://www.cstools.interactivebrokers.com" successful="false">
<CAElectionResult ibCAId="65607323">
<AccountElectionResult accountId="DU150462" successful="true" />
<CorpAction ibCAId="65607323" isVoluntary="true" includesDetails="false" includesPositions="true">
<Security currency="USD" symbol="HLF" exchange="NYSE" description="HERBALIFE LTD">
<SecurityId idScheme="ISIN" val="KYG4412G1010" />
</Security>
<CAPosition accountId="DU150462" position="1000" positionTime="2017-09-29T09:30:00-04:00" />
<CAElection accountId="DU150462" ibCAId="65607323">
<Election choiceNum="2" qty="920" />
<Election choiceNum="3" qty="1080" bidPrice="67.5" />
</CAElection>
</CorpAction>
</CAElectionResult>
</CAElectResponse>Copy
Multiple
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CAElectResponse xmlns="http://www.cstools.interactivebrokers.com" successful="false">
<CAElectionResult ibCAId="65607323">
<CorpAction ibCAId="65607323" isVoluntary="true" includesDetails="false" includesPositions="true">
<Security currency="USD" symbol="HLF" exchange="NYSE" description="HERBALIFE LTD">
<SecurityId idScheme="ISIN" val="KYG4412G1010" />
</Security>
<CAPosition accountId="DU150462" position="1000" positionTime="2017-09-29T09:30:00-04:00" />
<CAElection accountId="DU150462" ibCAId="65607323">
<Election choiceNum="2" qty="920" />
<Election choiceNum="3" qty="1080" bidPrice="67.5" />
</CAElection>
</CorpAction>
<AccountElectionResult accountId="DU150462" successful="true" />
<AccountElectionResult accountId="DU12345" successful="false">
<messages code="INVALID_CUSTACCT" severity="ERROR" message="Invalid account ID" />
</AccountElectionResult>
</CAElectionResult>
<CAElectionResult ibCAId="65607324">
<CorpAction ibCAId="65607324" isVoluntary="false" includesDetails="false" includesPositions="true">
<Security currency="USD" symbol="41420KCL3 " exchange="OTC" description="41420KCL3 4 3/8 09/01/17">
<SecurityId idScheme="ISIN" val="US41420KCL35" />
</Security>
</CorpAction>
<AccountElectionResult accountId="DU150462" successful="false">
<messages code="UNEXPECTED_ERROR" severity="ERROR" message="Unexpected error" />
</AccountElectionResult>
</CAElectionResult>
<CAElectionResult ibCAId="456">
<AccountElectionResult accountId="DU12345" successful="false">
<messages code="INVALID_CAID" severity="ERROR" message="Invalid corp action ID" />
<messages code="INVALID_CUSTACCT" severity="ERROR" message="Invalid account ID" />
</AccountElectionResult>
</CAElectionResult>
<CAElectionResult ibCAId="123">
<AccountElectionResult accountId="DU150462" successful="false">
<messages code="INVALID_CAID" severity="ERROR" message="Invalid corp action ID" />
</AccountElectionResult>
</CAElectionResult>
</CAElectResponse>
