LSEG Data Library for TypeScript

Built with Pandora

HistoricalPricing.Metadata.Partialbar.Definition object

This object creates the definition that can be used to retrieve partial bar metadata information for an instrument.

Syntax

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

Parameters

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

HistoricalPricing.Metadata.Partialbar.Params properties

Value Description Data type Optional Default value
name Single instrument name string No -
types List of metadata fields string 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 partial bar definition object to retrieve information about '' universe.

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

const definition = HistoricalPricing.Metadata.Partialbar.Definition({
    name: 'VOD.L',
});

`
104 words (0:33 mins)