CASearchRequest
https://[domain]/ws/cacapi.ext/submit
-
Query list of corporate actions by account, custom group of accounts, OR all accounts underneath the master account ID for specific date range.
Request Parameters
XSD
<xsd:element name="CASearchRequest" >
<xsd:complexType>
<xsd:sequence>
<xsd:attribute name="corpActionType" type="CAType" use="required"/>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="accountIds" type="xsd:string" use="optional"/>
<xsd:attribute name="subAccountsChoice" type="SubAccountChoice" use="required"/>
<xsd:attribute name="fromDate" type="YYYY-MM-DD" use="required"/>
<xsd:attribute name="toDate" type="YYYY-MM-DD" 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. |
|
accountIds |
String |
IBKR Account ID. Only required IF subAccountsChoice is SPECIFIED. |
|
subAccountsChoice |
NONE INCLUDE_SUBS SPECIFIED |
NONE: Includes detail for master only. INCLUDE_SUBS: Includes detail for master AND all sub accounts. SPECIFIED: Sub specific. |
|
fromDate |
YYYYMMDD |
View corporate actions assigned to account(s) during a specific time period. |
|
toDate |
YYYYMMDD |
Filter by date when corporate action was assigned. If start date is provided, toDate is required. |
|
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 Chiense |
Sample
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CASearchRequest corpActionType="ALL" accountId="I23456" subAccountsChoice="INCLUDE_SUBS"
fromDate="20180501" toDate="20180601" xmlns="http://www.cstools.interactivebrokers.com"/><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CASearchRequest corpActionType="ALL" accountId="I23456" subAccountsChoice="INCLUDE_SUBS"
fromDate="20180501" toDate="20180601" xmlns="http://www.cstools.interactivebrokers.com">
<accountIds>U123456</accountIds>
<accountIds>U666666</accountIds>
</CASearchRequest>
Sample
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CAResponse successful="true" xmlns="http://www.cstools.interactivebrokers.com">
<CorpAction ibCAId="70901561" type="CashDividend"
isVoluntary="false" effectiveDate="2018-05-10" recordDate="2018-05-11"
payDate="2018-05-17" decisionState="NEW"
lastUpdateDecisionTime="2018-05-07T14:44:41-04:00" includesDetails="true" includesPositions="true">
<Security symbol="OA" exchange="NYSE" description="ORBITAL ATK INC">
<SecurityId idScheme="ISIN" val="US68557N1037" />
</Security>
<CashDelivery>
<Cash currency="USD" amount="0.32" />
</CashDelivery>
<CAPosition accountId="U123456" position="0" />
</CorpAction>
<CorpAction ibCAId="70244142" type="CashDividend"
isVoluntary="false" effectiveDate="2018-05-08" recordDate="2018-05-09"
payDate="2018-05-11" decisionState="NEW"
lastUpdateDecisionTime="2018-05-03T15:34:55-04:00" includesDetails="true" includesPositions="true">
<Security symbol="NAP" exchange="NYSE" description="NAVIOS MARITIME MIDSTREAM PA">
<SecurityId idScheme="ISIN" val="MHY621341046" />
</Security>
<CashDelivery>
<Cash currency="USD" amount="0.125" />
</CashDelivery>
<CAPosition accountId="U123456" position="600" />
<CAPosition accountId="U987654" position="5" />
</CorpAction>
</CAResponse>
