LSEG Data Library for TypeScript

Built with Pandora

HistoricalPricing.Metadata.Instrument.Definition object

This is the definition object used to retrieve both events and summaries for a particular instrument.

Syntax

HistoricalPricing.Metadata.ViewList.Definition(params: HistoricalPricing.Metadata.ViewList.Params)

Parameters

Value Description Data type Optional Default value
params An object literal of type HistoricalPricing.Metadata.ViewList.Params object No -

HistoricalPricing.Metadata.ViewList.Params properties

Value Description Data type Optional Default value
name Single instrument name string No -
types List of metadata fields Types[] or string Yes -
version Metadata API version string Yes -
extendedParams Additional parameters to apply to the request object Yes -

Returned value

ContentDefinition object.

Usage

The following example demonstrates how to create a historical pricing metadata instrument definition object to retrieve version v2 timezone and trading sessions metadata for MSFT.O instrument.

import { HistoricalPricing } from '@lsegroup/data';

const definition = HistoricalPricing.Metadata.ViewList.Definition({
    name: 'TRI.N',
});

`
107 words (0:34 mins)