shortcutxl 0.2.0

package/skills/integrations/refinitiv.md

@@ -0,0 +1,473 @@
+**LSEG Refinitiv (Workspace/Eikon/Datastream) Excel Formula Guide**
+
+**Intro**
+You have full access to LSEG Refinitiv through the Excel Add-In, but you should only pull Refinitiv data **when the user explicitly tells you to**. LSEG Refinitiv provides market data, fundamentals, estimates, ownership, news, and time series through multiple platforms: Workspace (current), Eikon (legacy), and Datastream (time series). You can retrieve data by writing formulas directly in Excel cells.
+
+**IMPORTANT:** Before completing a task involving Refinitiv, you must verify:
+1. Your Refinitiv formulas do not return errors.
+2. All values should seem reasonable and make intuitive sense based on your general knowledge of companies and finance.
+3. Use cell references for instruments and fields when possible as opposed to hardcoded values.
+
+You should essentially gut check every value that shows up. If there are any errors or the values seem wrong, you likely wrote the formula syntax incorrectly. Please correct the formula until it outputs the proper value.
+
+---
+
+**Platform Overview**
+
+LSEG Refinitiv has multiple Excel integration methods:
+
+| Platform | Function | Status |
+|----------|----------|--------|
+| Workspace | RDP.Data, RDP.HistoricalPricing, RDP.Search | Current |
+| Eikon | TR, RHistory, RSearch | Legacy (still supported) |
+| Datastream | DSGRID, DS | Time series specialist |
+
+---
+
+## PART 1: WORKSPACE / EIKON FORMULAS
+
+**1. RDP.Data (Workspace) / TR (Eikon)**
+
+Returns current/static data for instruments.
+
+**Workspace Syntax:**
+=RDP.Data("INSTRUMENT","FIELD","PARAMETERS")
+
+**Eikon Syntax:**
+=TR("INSTRUMENT","FIELD","PARAMETERS")
+
+**Examples:**
+=RDP.Data("AAPL.O","TR.PriceClose")
+→ Apple's closing price.
+
+=TR("MSFT.O","CF_LAST")
+→ Microsoft's last trade price (real-time).
+
+=RDP.Data("GOOGL.O","TR.TotalRevenue","Period=FY0")
+→ Alphabet's most recent fiscal year revenue.
+
+---
+
+**2. Instrument Identifiers (RICs)**
+
+RIC (Reuters Instrument Code) is the primary identifier format.
+
+**Common RIC Suffixes:**
+| Suffix | Exchange | Example |
+|--------|----------|---------|
+| .O | NASDAQ | AAPL.O |
+| .N | NYSE | IBM.N |
+| .L | London | VOD.L |
+| .T | Tokyo | 7203.T |
+| .HK | Hong Kong | 0005.HK |
+| .DE | Germany | DBKGn.DE |
+| .PA | Paris | BNPP.PA |
+| .SI | Singapore | DBS.SI |
+| .AX | Australia | BHP.AX |
+| .TO | Toronto | RY.TO |
+
+**Alternative Identifiers:**
+- ISIN: =RDP.Data("US0378331005","TR.PriceClose")
+- CUSIP: Supported via lookup
+- SEDOL: Supported via lookup
+
+---
+
+**3. Field Types**
+
+**CF_ Fields (Real-Time Streaming):**
+Real-time market data from streaming feed.
+
+| Field | Description |
+|-------|-------------|
+| CF_LAST | Last trade price |
+| CF_BID | Bid price |
+| CF_ASK | Ask price |
+| CF_CLOSE | Previous close |
+| CF_HIGH | Day high |
+| CF_LOW | Day low |
+| CF_VOLUME | Trading volume |
+| CF_TICK | Tick direction |
+| CF_YIELD | Yield |
+
+**TR. Fields (Historical/Fundamental/Reference):**
+Historical and fundamental data.
+
+---
+
+**4. Common TR. Fields**
+
+**Pricing & Market Data:**
+| Field | Description |
+|-------|-------------|
+| TR.PriceClose | Closing price |
+| TR.PriceOpen | Opening price |
+| TR.PriceHigh | Day high price |
+| TR.PriceLow | Day low price |
+| TR.Volume | Trading volume |
+| TR.PricePctChgYTD | YTD price change % |
+| TR.CompanyMarketCap | Market capitalization |
+| TR.EV | Enterprise value |
+| TR.BetaFiveYear | 5-year beta |
+| TR.SharesOutstanding | Shares outstanding |
+
+**Income Statement:**
+| Field | Description |
+|-------|-------------|
+| TR.Revenue | Total revenue |
+| TR.TotalRevenue | Total revenue (with parameters) |
+| TR.GrossProfit | Gross profit |
+| TR.OperatingProfit | Operating profit |
+| TR.EBITDA | EBITDA |
+| TR.EBIT | EBIT |
+| TR.NetIncome | Net income |
+| TR.BasicNormalizedEps | Basic EPS (normalized) |
+| TR.DilutedNormalizedEps | Diluted EPS (normalized) |
+| TR.CostofRevenueTotal | Cost of revenue |
+| TR.Depreciation | Depreciation |
+
+**Balance Sheet:**
+| Field | Description |
+|-------|-------------|
+| TR.CashAndSTInvestments | Cash & ST investments |
+| TR.TotalAssets | Total assets |
+| TR.TotalCurrentAssets | Current assets |
+| TR.TotalReceivables | Total receivables |
+| TR.Inventory | Inventory |
+| TR.NetPPE | Net PP&E |
+| TR.TotalLiabilities | Total liabilities |
+| TR.TotalCurrentLiabilities | Current liabilities |
+| TR.TotalDebt | Total debt |
+| TR.NetDebtTot | Net debt |
+| TR.TotalEquity | Total equity |
+| TR.TtlCmnSharesOut | Common shares outstanding |
+
+**Cash Flow:**
+| Field | Description |
+|-------|-------------|
+| TR.CashFromOperations | Operating cash flow |
+| TR.CapitalExpenditures | Capital expenditures |
+| TR.FreeCashFlow | Free cash flow |
+| TR.CashFromInvesting | Investing cash flow |
+| TR.CashFromFinancing | Financing cash flow |
+
+**Ratios & Metrics:**
+| Field | Description |
+|-------|-------------|
+| TR.ROE | Return on equity |
+| TR.ROA | Return on assets |
+| TR.ReturnonAvgTotEqtyPctNetIncomeBeforeExtraItemsTTM | ROE TTM |
+| TR.ROAPercentTrailing12M | ROA trailing 12M |
+| TR.GrossMargin | Gross margin |
+| TR.OperatingProfitMarginPct5YrAvg | Operating margin 5Y avg |
+| TR.NetDebtToEBITDA | Net debt/EBITDA |
+| TR.PriceToSalesPerShare | Price/Sales |
+| TR.PriceToBookValue | Price/Book |
+| TR.PriceEarningsRatio | P/E ratio |
+
+**Estimates (Consensus):**
+| Field | Description |
+|-------|-------------|
+| TR.RevenueMeanEstimate | Revenue estimate (mean) |
+| TR.EBITDAMean | EBITDA estimate (mean) |
+| TR.EBITMean | EBIT estimate (mean) |
+| TR.NetIncomeMeanEstimate | Net income estimate (mean) |
+| TR.EPSMeanEstimate | EPS estimate (mean) |
+| TR.PriceTargetMeanEst | Price target (mean) |
+| TR.RecMean | Recommendation (mean) |
+| TR.RecLabel | Recommendation (label) |
+| TR.CAPEXMean | CapEx estimate (mean) |
+| TR.OPRMeanEstimate | Operating profit estimate |
+
+**Company Information:**
+| Field | Description |
+|-------|-------------|
+| TR.CompanyName | Company name |
+| TR.CommonName | Common name |
+| TR.RIC | RIC code |
+| TR.BusinessSummary | Business description |
+| TR.HeadquartersRegion | HQ region |
+| TR.TRBCIndustry | Industry classification |
+| TR.TRBCSector | Sector classification |
+
+---
+
+**5. Period Parameters**
+
+Add period specifications for fundamental data:
+
+| Parameter | Description | Example |
+|-----------|-------------|---------|
+| Period=FY0 | Current fiscal year | TR.Revenue(Period=FY0) |
+| Period=FY-1 | Prior fiscal year | TR.Revenue(Period=FY-1) |
+| Period=FQ0 | Current fiscal quarter | TR.Revenue(Period=FQ0) |
+| Period=LTM | Last twelve months | TR.Revenue(Period=LTM) |
+| Methodology=InterimSum | Interim sum method | TR.TotalRevenue(Period=LTM,Methodology=InterimSum) |
+
+**Date Range:**
+Period=1FQ2018:1FQ2025
+
+**Example:**
+=RDP.Data("AAPL.O","TR.RevenueActValue","Period=1FQ2018:1FQ2025,Curn=USD")
+→ Apple quarterly revenue from Q1 2018 to Q1 2025 in USD.
+
+---
+
+**6. Currency Conversion**
+
+| Parameter | Description |
+|-----------|-------------|
+| Curn=USD | Convert to USD |
+| Curn=EUR | Convert to EUR |
+| Curn=GBP | Convert to GBP |
+
+**Example:**
+=RDP.Data("VOD.L","TR.TotalRevenue","Period=FY0,Curn=USD")
+→ Vodafone revenue in USD.
+
+---
+
+**7. Historical Pricing (RDP.HistoricalPricing / RHistory)**
+
+For time series price data.
+
+**Workspace Syntax:**
+=RDP.HistoricalPricing("INSTRUMENT","FIELDS","START","END","FREQUENCY")
+
+**Eikon Syntax:**
+=RHistory("INSTRUMENT","FIELDS","START","END","FREQUENCY")
+
+**Example:**
+=RHistory("AAPL.O","TR.PriceClose","-1Y","0D","D")
+→ Apple daily closing prices for past year.
+
+---
+
+**8. Display Parameters**
+
+| Parameter | Values | Description |
+|-----------|--------|-------------|
+| CH | Fd, In, Date | Column headers (Field, Instrument, Date) |
+| RH | Fd, In, Date | Row headers |
+| Transpose | Y, N | Transpose results |
+
+**Example:**
+=TR("AAPL.O;MSFT.O;GOOGL.O","CF_LAST;TR.CompanyMarketCap;TR.Revenue","CH=Fd RH=IN")
+→ Multiple instruments and fields with headers.
+
+---
+
+## PART 2: DATASTREAM FORMULAS
+
+Datastream specializes in long historical time series data.
+
+**1. DSGRID Function**
+
+Returns time series data in a grid format.
+
+**Syntax:**
+=DSGRID(SERIES, DATATYPE, START, END, FREQUENCY)
+
+**Examples:**
+=DSGRID("AAPL","P","-5Y","0","M")
+→ Apple monthly prices for past 5 years.
+
+=DSGRID("VOD","MV","-10Y","0","Q")
+→ Vodafone quarterly market value for past 10 years.
+
+---
+
+**2. DS Function**
+
+Returns single data points.
+
+**Syntax:**
+=DS(SERIES, DATATYPE, DATE, CURRENCY, OPTIONS)
+
+**Example:**
+=DS("MSFT","P","0")
+→ Microsoft's current price.
+
+---
+
+**3. Datastream Series Codes**
+
+Datastream uses its own mnemonic system for instruments.
+
+**Finding Codes:**
+- Use Datastream Navigator in Excel
+- Search by company name, ISIN, or SEDOL
+- Common stocks often use ticker-like codes (e.g., "AAPL" for Apple)
+
+---
+
+**4. Common Datastream Datatypes**
+
+**Pricing:**
+| Datatype | Description |
+|----------|-------------|
+| P | Closing price |
+| PH | High price |
+| PL | Low price |
+| PO | Opening price |
+| VA | Value traded |
+| VO | Volume traded |
+
+**Market Data:**
+| Datatype | Description |
+|----------|-------------|
+| MV | Market value/capitalization |
+| NOSH | Number of shares (thousands) |
+| UP | Unadjusted price |
+| RI | Return index (total return) |
+| PI | Price index |
+
+**Fundamentals:**
+| Datatype | Description |
+|----------|-------------|
+| EPS | Earnings per share |
+| DPS | Dividends per share |
+| DY | Dividend yield |
+| PE | Price/Earnings ratio |
+| PTBV | Price to book value |
+| MTBV | Market to book value |
+| WC01001 | Net sales/revenue (Worldscope) |
+| WC01551 | Operating income (Worldscope) |
+| WC01751 | Net income (Worldscope) |
+| WC02999 | Total assets (Worldscope) |
+| WC03351 | Total debt (Worldscope) |
+| WC03501 | Common equity (Worldscope) |
+
+**Rates & FX:**
+| Datatype | Description |
+|----------|-------------|
+| EB | Bid exchange rate |
+| EO | Offer exchange rate |
+
+---
+
+**5. Datastream Frequency Codes**
+
+| Code | Frequency |
+|------|-----------|
+| D | Daily |
+| W | Weekly |
+| M | Monthly |
+| Q | Quarterly |
+| Y | Yearly |
+
+---
+
+**6. Datastream Date Formats**
+
+| Format | Description | Example |
+|--------|-------------|---------|
+| -5Y | 5 years ago | -5Y |
+| -6M | 6 months ago | -6M |
+| -30D | 30 days ago | -30D |
+| 0 | Today/current | 0 |
+| DD/MM/YYYY | Absolute date | 01/01/2020 |
+
+---
+
+**7. Datastream Expressions**
+
+You can create calculated fields:
+
+=DSGRID("AAPL","P/EPS","-5Y","0","Y")
+→ Apple's P/E ratio over 5 years.
+
+=DSGRID("VOD","MV/WC01001","-3Y","0","Y")
+→ Vodafone's Market Cap / Revenue ratio.
+
+---
+
+**8. Worldscope Codes**
+
+Datastream includes Worldscope fundamental data with WC prefix:
+
+**Income Statement:**
+| Code | Description |
+|------|-------------|
+| WC01001 | Net sales/revenue |
+| WC01051 | Cost of goods sold |
+| WC01100 | Gross income |
+| WC01250 | SG&A expense |
+| WC01551 | Operating income |
+| WC01651 | EBIT |
+| WC18198 | EBITDA |
+| WC01651 | Pretax income |
+| WC01751 | Net income |
+| WC05201 | EPS (basic) |
+| WC05202 | EPS (diluted) |
+
+**Balance Sheet:**
+| Code | Description |
+|------|-------------|
+| WC02001 | Cash & equivalents |
+| WC02051 | Receivables |
+| WC02101 | Inventories |
+| WC02201 | Current assets |
+| WC02501 | Net PP&E |
+| WC02999 | Total assets |
+| WC03051 | Accounts payable |
+| WC03251 | Current liabilities |
+| WC03351 | Total debt |
+| WC03451 | Long-term debt |
+| WC03501 | Common equity |
+| WC03995 | Total liabilities |
+| WC03999 | Total liabilities & equity |
+
+**Cash Flow:**
+| Code | Description |
+|------|-------------|
+| WC04201 | Operating cash flow |
+| WC04601 | Capital expenditures |
+| WC04860 | Free cash flow |
+
+---
+
+## PART 3: FORMULA BUILDER
+
+**Using Formula Builder (Recommended):**
+1. Open Excel with Refinitiv Add-In
+2. Click "Refinitiv" or "LSEG" tab
+3. Click "Build Formula" or "fx" icon
+4. Use Navigator to find instruments
+5. Use Data Item Browser to find fields
+6. Set parameters and insert formula
+
+**Data Item Browser (DIB):**
+- Press F1 or access via Eikon for context help
+- Search fields by keyword
+- Browse by category (Pricing, Fundamentals, Estimates, etc.)
+
+---
+
+**Migration Note (Eikon to Workspace):**
+
+If migrating from Eikon to Workspace:
+- =TR("AAPL.O","TR.CompanyName") becomes =RDP.Data("AAPL.O","TR.CompanyName")
+- Most field names remain the same
+- CF_ and TR. field prefixes unchanged
+
+---
+
+**Final Checklist:**
+- What exact data point is needed? (Price? Revenue? EBITDA? Estimates?)
+- What time frame? (Current? Historical? Specific fiscal period?)
+- Is this for Workspace (RDP.Data) or Eikon (TR) or Datastream (DSGRID)?
+- Is the instrument identifier correct? (RIC format with exchange suffix)
+- Do I need real-time (CF_) or historical/fundamental (TR.) data?
+- Have I specified the period correctly? (FY0, FY-1, LTM, etc.)
+- Do I need currency conversion? (Curn=USD)
+- Have I checked the field using Data Item Browser?
+
+---
+
+**Additional Resources:**
+- Refinitiv Workspace: Press F1 for context help
+- Data Item Browser: Search for field codes
+- Datastream Navigator: Find time series codes
+- Developer Community: community.developers.refinitiv.com
+- Formula Builder: Accessed via Excel Add-In tab