SymbolConversion.Definition object
This object creates a definition of information about the data that will be passed to the Search/Lookup API of the Refinitiv Data Platform.
Syntax
SymbolConversion.Definition(params: SymbolConversion.Params)
Parameters
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| params | An object literal of type SymbolConversion.Params | object | No | - |
SymbolConversion.Params properties
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| symbols | Single instrument or list of instruments to convert | string or string[] | No | - |
| fromSymbolType | Instrument code to convert from. Possible values: CUSIP, ISIN, SEDOL, RIC, ticker, lipperID, IMO | string | Yes | - |
| toSymbolType | Instrument code to convert to. Possible values: CUSIP, ISIN, SEDOL, RIC, Ticker, LipperID, IMO, OAPermID | string or string[] | Yes | - |
| preferredCountryCode | RCS code of a country. (See CountryCode | CountryCode | Yes | - |
| assetState | Add AssetState to Filter parameter (See SymbolConversion.AssetState | AssetState | Yes | - |
| assetClass | Add SearchAllCategoryv3 and RCSAssetCategoryGenealogy to Filter parameter (See SymbolConversion.AssetClass | AssetClass | Yes | - |
| extendedParams | Additional parameters to apply to the request. | object | Yes | - |
Returned value
ContentDefinition object.
Usage
The following example demonstrates how to create a symbol conversion definition object for 'MSFT.O'.
import { SymbolConversion } from '@refinitiv-data/data';
const definition = SymbolConversion.Definition({
symbols: ['MSFT.O'],
});
`