LSEG Data Library for Python

Built with Pandora

custom_instruments.summaries.Definition

This object is for retrieving the historical summaries data from custom instrument.

Module

refinitiv.data.content.custom_instruments.summaries

Syntax

summaries.Definition(universe)

Parameters

Value Description Data type Optional Default value
universe The Id or Symbol of custom instrument to operate on. str No -
interval The consolidation interval in ISO8601. str Yes -
start The start date and timestamp of the query in ISO8601 with UTC only. str Yes -
end The end date and timestamp of the query in ISO8601 with UTC only. str Yes -
count The maximum number of data returned. Values range: 1 - 10000. str Yes -

Returned value

custom_instruments.summaries.Definition instance

Usage

The following example demonstrates how to create the definition to retrieve custom instrument summaries:

from refinitiv.data.content.custom_instruments import summaries

search_def = summaries.Definition("S)My.CustomInstrument")

None.
108 words (0:34 mins)