LSEG Data Library for TypeScript

Built with Pandora

getData

The getData function is used to send a request to the Delivery Platform (formerly Refinitiv Data Platform) to retrieve the data described by the Holidays.Definitions object.

Syntax

definitions.getData(session?: Session)

Parameters

Value Description Data type Optional Default value
session Session object. If it's not passed the default session will be used. Session Yes -

Returned value

ContentResponse object.

Usage

The following example shows how to get data with multiple holiday definitions:

const holidaysDefinition1 = IPA.DatesAndCalendars.Holidays.Definition({
    tag: 'My request 1',
    startDate: '2018-12-31',
    endDate: '2019-01-03',
    calendars: ['UKR', 'FRA'],
    currencies: ['EUR'],
    extendedParams: {
        holidayOutputs: [
            IPA.DatesAndCalendars.HolidayOutput.Calendars,
            IPA.DatesAndCalendars.HolidayOutput.Calendars,
            IPA.DatesAndCalendars.HolidayOutput.Calendars,
            IPA.DatesAndCalendars.HolidayOutput.Countries,
        ]
    }
});

const holidaysDefinition2 = IPA.DatesAndCalendars.Holidays.Definition({
    tag: 'My request 2',
    startDate: '2020-01-01',
    endDate: '2021-01-01',
    calendars: ['FRA'],
    currencies: ['invalid'],
    holidayOutputs: [
        IPA.DatesAndCalendars.HolidayOutput.Calendars,
        IPA.DatesAndCalendars.HolidayOutput.Countries,
    ]
});

const definitions = IPA.DatesAndCalendars.Holidays.Definitions([holidaysDefinition1, holidaysDefinition2]);

const result = await definitions.getData(session);

console.log(result.data);

None.
65 words (0:21 mins)