HistoricalPricing.Summaries.Definition object
This object creates the definition of information about particular historical pricing summaries that we want to get.
Syntax
HistoricalPricing.Summaries.Definition(params: HistoricalPricing.Summaries.Params)
Parameters
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| params | An object literal of type HistoricalPricing.Summaries.Params | object | No | - |
HistoricalPricing.Summaries.Params properties
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| universe | Single instrument or list of instruments | string or string[] | No | - |
| fields | List of fields to return | string[] | Yes | - |
| interval | The consolidation interval in ISO8601 | string | Yes | - |
| start | Start time for the events query | string | Yes | - |
| end | End time for the events query | string | Yes | - |
| adjustments | A list of adjustment types to apply | string[] | Yes | - |
| count | The maximum number of rows to return | number | Yes | - |
| session | The list of market session classification | string[] | Yes | - |
| summaryTimestampLabel | The pattern of timestamp label in the response | string | Yes | - |
| extendedParams | Additional parameters to apply to the request | object | Yes | - |
Returned value
ContentDefinition object.
Usage
The following examples demonstrates how to create a historical pricing summaries definition object for LSEG.L to retrieve the 20 most recent summaries.
import { HistoricalPricing } from '@refinitiv-data/data';
const definition = HistoricalPricing.Summaries.Definition({
universe: 'LSEG.L',
});
`