HistoricalPricing.Events.Definition object
This object defines the Historical Pricing Events to be retrieved.
Syntax
HistoricalPricing.Events.Definition(params: HistoricalPricing.Events.Params)
Parameters
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| params | An object literal of type HistoricalPricing.Events.Params | object | No | - |
HistoricalPricing.Events.Params properties:
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| universe | The entity universe e.g. RIC name | string or string[] | No | - |
| fields | List of fields to return | list | Yes | - |
| eventTypes | A list of event types to apply | 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 | - |
| 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 events definition object for LSEG.L which retrieves the 20 most recent events.
import { HistoricalPricing } from '@refinitiv-data/data';
const definition = HistoricalPricing.Events.Definition({
universe: 'LSEG.L',
});
`