{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Actions API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Actions", "type": "folder" }, "items": [ { "info": { "name": "Factset Gets Corporate Actions Information.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-global-prices/v1/corporate-actions", "params": [ { "name": "ids", "value": "", "type": "query", "description": "The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids.

***ids limit** = 1000 per non-batch request / 2000 per batch request for a single day and 50 per multi-day request*

*

Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, it's advised for any requests with large request lines to be requested through the respective \"POST\" method.

*" }, { "name": "eventCategory", "value": "", "type": "query", "description": "Selects the Event Category to include in the response.\n * **CASH_DIVS** = Cash Dividends\n * **STOCK_DIST** = Stock Distributions\n * **SPINOFFS** = Spin Offs\n * **RIGHTS** = Rights Issue\n * **SPLITS** = Splits\n * **ALL** = Returns all Event Types. If left blank the service will default to ALL.\n" }, { "name": "fields", "value": "", "type": "query", "description": "Request available Corporate Actions data fields to be included in the response.\nDefault is all fields. _fsymId_, _effectiveDate_, _eventTypeCode_ and _requestId_ are always included.\n\n |field|description|\n |||\n |fsymId|Factset Regional Security Identifier|\n |eventTypeCode|Character code that denotes the type of event|\n |effectiveDate|The date when security is traded ex-dividend|\n |requestId|Identifier that was used for the request.|\n\n

Common Fields

\n |field|description|\n |||\n |eventId|Uniquely Identifies the event|\n |eventTypeDesc|Description of the type of event|\n |divTypeCode|Dividend type code. [OA#8764](https://my.apps.factset.com/oa/pages/8764)|\n |announcementDate|Date the event was publicly announced|\n |recordDate|Record date of the event|\n |payDate|Payment date of the event|\n

Dividend Fields

\n |field|description|\n |||\n |currency|Currency ISO code associated with distribution amount converted into trading currency of the record.|\n |amtDefNetGrossIndicator|Indicates whether the default amount is net or gross. G=Gross; N=Net.|\n |amtDefTradingAdj|Cash distribution amount (net or gross) in the trading currency of the record. Amount is translated to the trading currency based on the exchange rate as of the effective date.\nThe value is adjusted for splits.|\n |amtDefTradingUnadj|Cash distribution amount (net or gross) in the trading currency of the record. Amount is translated to the trading currency based on the exchange rate as of the effective date.\nThe value is not adjusted for splits. |\n |amtNetTradingAdj|Net distribution amount in the trading currency of the record. Amount is translated to the trading currency based on the exchange rate as of the effective date. The value is\nadjusted for splits.|\n |amtNetTradingUnadj|Net distribution amount in the trading currency of the record. Amount is translated to the trading currency based on the exchange rate as of the effective date. The value is\nnot adjusted for splits.|\n |amtGrossTradingAdj|Gross distribution amount in the trading currency of the record. Amount is translated to the trading currency based on the exchange rate as of the effective date. The value\nis adjusted for splits.|\n |amtGrossTradingUnadj|Gross distribution amount in the trading currency of the record. Amount is translated to the trading currency based on the exchange rate as of the effective date. The value\nis not adjusted for splits.|\n |declaredCurrency|Currency ISO code associated with the declared amount. |\n |amtDefDecAdj|Cash distribution amount (net or gross) in the currency it was declared in. The value is adjusted for splits.|\n |amtDefDecUnadj|Cash distribution amount (net or gross) in the currency it was declared in. The value is not adjusted for splits.|\n |amtNetDecAdj|Net cash distribution amount in the currency it was declared in. The value is adjusted for splits. |\n |amtNetDecUnadj|Net cash distribution amount in the currency it was declared in. The value is not adjusted for splits.|\n |amtGrossDecAdj|Gross cash distribution amount in the currency it was declared in. N/A is returned if the gross amount is not available. The value is adjusted for splits.|\n |amtGrossDecUnadj|Gross cash distribution amount in the currency it was declared in. The value is not adjusted for splits.|\n |dividendStatus|Identifies the cancelled dividends status( Active, Cancelled, Postponed, Partial Information) and helps to evaluate their price and portfolio performance.Its applicable to Dividend(DVC)\nand Dividend with DRP option(DVCD)|\n |dividendActiveFlag|Identifies whether the dividend record is currently active(1) or inactive(0).Its applicable to Dividend(DVC) and Dividend with DRP option(DVCD)|\n |dividendsSpecFlag|Indicates a special price implications exists, which may or may not include special dividends. Indicates whether an adjustment should be made to historical pricing.|\n |dividendFrequencyDesc|Dividend Frequency for different event types in the form of a text as per the descriptions found here [OA#8764](https://my.apps.factset.com/oa/pages/8764#Frequency)|\n |dividendFrequencyCode|Dividend Frequency for different event types in the form of a code as per the details found here [OA#8764](https://my.apps.factset.com/oa/pages/8764#Frequency)|\n |frankDefTradingAdj|Split amount of dividend that is franked (subject to tax credit). Published in the trading currency of the input ID. Amount is translated to the trading currency based on the\nexchange rate as of the effective date.**Only applicable for Australian Securities**.|\n |frankDefTradingUnadj|Unsplit amount of dividend that is franked (subject to tax credit). Published in the trading currency of the input ID. Amount is translated to the trading currency based\non the exchange rate as of the effective date.**Only applicable for Australian Securities**.|\n |frankDefDecAdj|Split amount of dividend that is franked (subject to tax credit). Published in the currency the dividend was declared in.Amount is translated to the trading currency based on the\nexchange rate as of the effective date. **Only applicable for Australian Securities**.|\n |frankDefDecUnadj|Unsplit amount of dividend that is franked (subject to tax credit). Published in the currency the dividend was declared in.Amount is translated to the trading currency based\non the exchange rate as of the effective date. **Only applicable for Australian Securities**.|\n |frankPct|Percent of total dividend that is franked (subject to tax credit). **Only applicable for Australian Securities**.|\n |taxRate|Domestic Withholding Tax Rate for a Resident Individual|\n

Distribution Fields

\n |field|description|\n |||\n |adjFactor|Factor applied to adjust historical prices. Calculation formulas are available on [OA#12619](https://my.apps.factset.com/oa/pages/12619)|\n |adjFactorCombined|Combined adjustment factor for all distribution events on that day.|\n |amtDefTradingAdj|Cash distribution amount (net or gross) in the trading currency of the record. Amount is translated to the trading currency based on the exchange rate as of the effective date.\nThe value is adjusted for splits.|\n |amtDefTradingUnadj|Cash distribution amount (net or gross) in the trading currency of the record. Amount is translated to the trading currency based on the exchange rate as of the effective date.\nThe value is not adjusted for splits. |\n |currency|Currency ISO code associated with distribution amount converted into trading currency of the record.|\n |distPct|Distribution percentage of the event (i.e. 10%). Typical for stock distributions.|\n |distOldTerm|Component of distribution ratio- Number of shares held.|\n |distNewTerm|Component of distribution ratio - Number of shares received.|\n |rightsIssuePrice|Price of the rights issue. |\n |rightsIssueCurrency|Currency the rights issue price was declared in.|\n |shortDesc|Textual description identifying the event. Example- Split (Mandatory): 3 for 1.|\n

Splits Fields

\n |field|description|\n |||\n |adjFactor|Distribution percentage of the event (i.e. 10%). Typical for stock distributions.|\n |adjFactorCombined|Combined adjustment factor for all distribution events on that day.|\n |distOldTerm|Component of distribution ratio- Number of shares held.|\n |distNewTerm|Component of distribution ratio - Number of shares received.|\n |distInstFsymId|Helps to identify an instrument representing the distributed company or security associated with ca event identifier. Its applicable for types like Bonus issue(BNS),Stock dividend(DVS),Rights\nissue (DSR), and spin off(SPO).|\n |shortDesc|Textual description identifying the event. Example- Split (Mandatory): 3 for 1.|\n" }, { "name": "startDate", "value": "2019-01-01", "type": "query", "description": "The start date requested for a given date range in **YYYY-MM-DD** format. In the context of corporate actions, this filters the response to only include events within the date range. The frequency between the startDate and endDate is always set to the \"event\" frequency- meaning the service will return only events within those inclusive boundaries. Leaving both startDate and endDate blank will pull \"all\" events for each requested ids.\n" }, { "name": "endDate", "value": "2019-12-31", "type": "query", "description": "The end date requested for a given date range in **YYYY-MM-DD** format. In the context of corporate actions, this filters the response to only include events within the date range. The frequency between the startDate and endDate is always set to the \"event\" frequency- meaning the service will return only events within those inclusive boundaries. Leaving both startDate and endDate blank will pull \"all\" events for each requested ids.\n" }, { "name": "currency", "value": "USD", "type": "query", "description": "Currency code for adjusting prices. Default is Local. For a list of currency ISO codes, visit [Online Assistant Page 1470](https://oa.apps.factset.com/pages/1470)." }, { "name": "cancelledDividend", "value": "exclude", "type": "query", "description": "The cancelled dividend returns the dividend details whether they are cancelled or active.\n" }, { "name": "batch", "value": "", "type": "query", "description": "Enables the ability to asynchronously \"batch\" the request, supporting a long-running request for up to 20 minutes. Upon requesting batch=Y, the service will respond with an HTTP Status Code of 202.\nOnce a batch request is submitted, use batch status to see if the job has been completed. Once completed, retrieve the results of the request via batch-result. When using Batch, ids limit is increased to 10000 ids per request, though limits on query string via GET method still apply. It's advised to submit large lists of ids via POST method.\nPlease note that the number of unique currencies present in the requested ids is limited to 50 per request.\n" } ] }, "docs": "Gets the Corporate Actions amounts, dates, types, and flags over a specified date range.\nYou may request future dates to receive information for declared events.\n\nEvent Categories:\n* __Cash Dividends__ (CASH_DIVS)\n * **DVC** - Dividend\n * **DVCD** - Dividend with DRP Option\n * **DRP** - Dividend Reinvestment\n* __Stock Distributions__ (STOCK_DIST)\n * **DVS** - Stock Dividend\n * **DVSS** - Stock Dividend, Special\n * **BNS** - Bonus Issue\n * **BNSS** - Bonus Issue, Special\n* __Spin Offs__ (S" }, { "info": { "name": "Factset Requests Corporate Actions Information.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-global-prices/v1/corporate-actions", "body": { "type": "json", "data": "{}" } }, "docs": "Gets the Corporate Actions amounts, dates, types, and flags over a specified date range. You may request future dates to receive information for declared events.

**_startDate and endDate are required parameters. The input startDate must come before the input endDate._**" } ] } ], "bundled": true }