CARequest

Search Corporate Action details and positions by Corporate Action ID.

Request Parameters

XSD

Copy

<xsd:element name="CARequest" >
       <xsd:complexType>
            <xsd:sequence>
                <xsd:element name="ibCAId" type="xsd:long" minOccurs="1" maxOccurs="100"/>
                <xsd:element name="accountIds"       type="xsd:string" minOccurs="0" maxOccurs="100"/>
            </xsd:sequence>
            <xsd:attribute name="accountId"      type="xsd:string"       use="required"/>
            <xsd:attribute name="subAccountsChoice"  type="SubAccountChoice" use="required"/>
            <xsd:attribute name="includeDetails"     type="xsd:boolean"      use="required"/>
            <xsd:attribute name="includePositions"   type="xsd:boolean"      use="required"/>
            <xsd:attribute name="lang"               type="xsd:string"       use="optional"/>
        </xsd:complexType>
</xsd:element>

Attributes

Name	Type	Description
corpActionType	String	IBKR account ID of the advisor/broker client application that is being deleted
accountId	String	IBKR Account ID. If subAccountsChoice is SPECIFIED, include comma separated list of account Ids.
subAccountsChoice	NONE INCLUDE_SUBS SPECIFIED	NONE INCLUDE_SUBS SPECIFIED
includeDetails	true false
includePositions	true false
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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CARequest accountId="U12345" subAccountsChoice="NONE"
    includeDetails="true" includePositions="true" lang="Du"
    xmlns="http://www.cstools.interactivebrokers.com">
    <ibCAId>68992518</ibCAId>
</CARequest>

Response Parameters

Copy

Success:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CAResponse successful="true"
    xmlns="http://www.cstools.interactivebrokers.com">
    <CorpAction ibCAId="68992518" type="DividendRightsIssue"
        isVoluntary="true" effectiveDate="2018-05-07" recordDate="2018-05-08"
        payDate="2018-05-09" decisionState="ELECTABLE" lastUpdateDecisionTime="2018-05-07T04:02:21-04:00"
        electionStartDate="2018-05-07T06:00:00+02:00" defaultClientDeadline="2018-05-30T09:00:00+02:00"
        electionQtyMin="1" electionQtyMult="1" includesDetails="true"
        includesPositions="true" hasWithdrawalPrivileges="false"
        electionInstructionMinLot="1" lastElectedTime="2018-05-11T06:59:58-04:00"
        lastElectedBy="ibuser123" lastElectedByTag="AM">
        <OverviewDescription>KONINKLIJKE PHILIPS NV Choice Dividend
 
            The
            KONINKLIJKE PHILIPS NV company has announced a EUR 0.80 per share
            cash dividend.
 
            A shareholder has the choice to receive the dividend in
            cash or in
            shares at a reinvestment price which will be announced.
 
            In
            order to represent eligibility for this offer, dividend rights under
            ISIN:NL0012818520 will be issued on 2018-05-07.
 
            Restricted Countries:
            not mentioned
 
            All investors must verify that they are not acting
            against their country
            regulations and mentioned restrictions in the
            prospectus.
 
            Option 1: Elect Cash Dividend: EUR 0.80 per share less Tax
            (default)
 
            Option 2: Elect Stock Dividend: Reinvestment price to be
            announced
 
            The deadline to submit an election will be 2018-05-30 09:00
            (Europe/Zurich).
 
            In the absence of an election instruction, a
            shareholder will receive
            the dividend in cash, option 1 above.
        </OverviewDescription>
        <Security currency="EUR" symbol="PHIA.RTS" exchange="CORPACT"
            description="KONINKLIJKE PHILIPS NV - DIV RTS 180606">
            <SecurityId idScheme="ISIN" val="NL0012818520" />
        </Security>
        <AssetDelivery>
            <Security currency="EUR" symbol="PHIA.RTS" exchange="CORPACT"
                description="KONINKLIJKE PHILIPS NV - DIV RTS 180606">
                <SecurityId idScheme="ISIN" val="NL0012818520" />
            </Security>
            <Ratio numerator="1" denominator="1" />
        </AssetDelivery>
        <CAChoice number="1" isDefault="true">
            <description>Cash dividend: EUR 0.80 less Tax</description>
        </CAChoice>
        <CAChoice number="2" isDefault="false">
            <description>Stock dividend: reinvestment price tba</description>
        </CAChoice>
        <CAPosition accountId="U123456" position="100"
            positionTime="2018-05-04T20:25:00-04:00" />
        <CAElection accountId="U123456" ibCAId="68992518">
            <Election choiceNum="1" qty="100" lastElectedTime="2018-05-11T06:59:58-04:00"
                lastElectedBy="ibuser123" lastElectedByTag="AM" />
        </CAElection>
        <VersionDescription versionNumber="2"
            whenNotified="2018-05-29T12:24:57-04:00">
            <Description>.</Description>
        </VersionDescription>
        <VersionDescription versionNumber="1"
            whenNotified="2018-05-07T06:27:21-04:00">
            <Description>First notified version</Description>
        </VersionDescription>
    </CorpAction>
</CAResponse>