SymbolConversionDefinition
This definition is used to retrieve data from the Search/Lookup API of the Delivery Platform (formerly Refinitiv Data Platform).
Syntax
SymbolConversion.Definition(params string[] symbols)SymbolConversion.Definition(IEnumerable<string> symbols)
Parameters
| Value | Description | Optional | Default value |
|---|---|---|---|
| symbols | One or more instruments for which we want to retrieve symbols | No | - |
Symbol Types
The following is a table of supported symbol types that an instrument could have and that can also be used to request symbol data.
| Name | Description |
|---|---|
| RIC | Reuters Instrument Code. |
| ISIN | International Securities Identification Number. |
| CUSIP | Committee on Uniform Securities Identification Procedures. A unique ID used in the U.S and Canada. |
| SEDOL | Stock Exchange Daily Official List. A seven digit identifier traded on the LSE and other small exchanges across the UK. |
| Ticker | The unique Ticker symbol. |
| PermID | A Permanent Identfier uniquely indentifying an asset. |
| LipperID | LSEG's Lipper ID. |
| ANY | Any of the defined symbol types. Note: Only supported when using the full service. |
SymbolConversionDefinition Methods
Symbols(params string[] symbols)
Symbols(IEnumerable
Define a list of symbols to convert.
FromSymbolType(SymbolConversion.SymbolType type)
Defines the type of symbols specified within the Symbol specification.
Optional. Default: SymbolType.ANY.
ToSymbolType(params SymbolConversion.SymbolType[] types)
ToSymbolType(IEnumerable<SymbolConversion.SymbolType> types)
Defines the types to convert to. Optional. Default: All SymbolTypes.
Closure(object closure)
Optionally, include a user-defined Closure to match specific requests and responses.
Returned value
SymbolConversionDefinition object.
When requesting data using the GetData() methods, we will receive a SymbolConversionResponse object. The response object will contain a "Data" property of SymbolConversionData type. The Data property contains the list of symbols retrieved for that instrument(s) we have requested data.
A symbol conversion match is an object that contains a list of properties named as all the symbol types specified above. If the instrument has a value for that symbol type, it means that the symbol conversion match for the respective property will contain a value.
SymbolConversionMatch - properties
string Description { get; }
string RIC { get; }
string CUSIP { get; }
string ISIN
string SEDOL { get; }
string PermID { get; }
string LipperID { get; }
string Ticker { get; }
Usage
The following example demonstrates several use cases for symbol conversion.
using LSEG.Data.Content.Symbology;
using LSEG.Data.Core;
// RIC conversion
var response = SymbolConversion
.Definition()
.Symbols("IBM", "AAPL.O", "GOOGL.O", "LP60000008")
.FromSymbolType(SymbolConversion.SymbolType.RIC)
.GetData();
// PermID for private company.
// Note: data is available within Eikon but not within Search Lookup (RDP)
var missingID = "5050720719";
response = SymbolConversion
.Definition(missingID)
.FromSymbolType(SymbolConversion.SymbolType.PermID)
.GetData();
// ISINs - convert to all known symbol types
response = SymbolConversion
.Definition("US5949181045", "US02079K1079")
.FromSymbolType(SymbolConversion.SymbolType.ISIN)
.GetData();
// ISINs - convert to RIC and Ticker only. Include 1 bad ISIN.
var symbols = new List<string>() { "US5949181045", "JUNK", "US02079K1079" };
response = SymbolConversion
.Definition()
.Symbols(symbols)
.FromSymbolType(SymbolConversion.SymbolType.ISIN)
.ToSymbolType(SymbolConversion.SymbolType.RIC, SymbolConversion.SymbolType.Ticker)
.GetData();
// SEDOL - convert to all known
response = SymbolConversion
.Definition("BH4HKS3")
.FromSymbolType(SymbolConversion.SymbolType.SEDOL)
.GetData();
// Detect the mixed asset list.
response = SymbolConversion
.Definition("VOD.L", "037833100", "IBM", "US5949181045", "5030853586")
.GetData();
`
The responses retrieved also contain the raw JSON data.
You can explore and create your own objects and map the retrieved data to them to fit your specific business needs.