LSEG Data Library for Python

Built with Pandora

custom_instruments.Definition object

This object is responsible for retrieving a custom instrument.

Module

refinitiv.data.content.custom_instruments

Syntax

custom_instruments.Definition(universe)

Parameters

Name Is Optional Default Value Type Description
Value Description Data type Optional Default value
universe The Id or Symbol of custom instrument to operate on. str No -
extended_params Specifies the parameters that will be merged with the request. dict Yes -

Returned value

custom_instruments.Definition instance

Usage

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

from refinitiv.data.content.custom_instruments import Definition

definition = Definition(universe="S)MyNewInstrument")

None.

Methods

get_stream(session)

Allows you to create a CustomInstrumentsStream object for the defined data.

Parameters

Name Is Optional Default Value Type Description
session Yes - Session The Session defines the source where you want to retrieve your data.

Returned value

custom_instruments.CustomInstrumentsStream instance
106 words (0:33 mins)