Refinitiv Data Platform Library for TypeScript

getData

Sends request to the Refinitiv Data Platform to retrieve the search data described in the Search.Definition object.

Syntax

definition.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 demonstrates how to create a search query with particular options and get the necessary data:

import { Search } from '@refinitiv-data/data';

const definition = Search.Definition({
    query: "IBM Bonds",
    select: "ISIN,RIC,IssueDate,Currency,FaceIssuedTotal,CouponRate,MaturityDate",
});

const response = await definition.getData();

console.log(response.data.table);
Response
BusinessEntity DocumentTitle PermID PI RIC
0 ORGANISATION International Business Machines Corp, Public Company N/A 37036 N/A
1 ORGANISATION Banco IBM SA, Private Company N/A 76208 N/A
2 QUOTExEQUITY International Business Machines Corp, Ordinary Share, NYSE Consolidated 55839165994 1097326 IBM
3 ORGANISATION Tiers Corporate Bond Backed Certificates Trust Series Ibm 1997 4, Private Company N/A 18062670 N/A
4 QUOTExEQUITY Eurex International Business Machines Equity Future Chain Contract , Equity Future, USD, Eurex 21481052421 48924732 0#IBMF:
5 QUOTExEQUITY Euronext Amsterdam IBM Dividend Future Chain Contracts, Equity Future, USD, Euronext Amsterdam 21612423771 259118763 0#IBMDF:
6 QUOTExEQUITY Eurex International Business Machines Equity Future Continuation 1, Equity Future, USD, Eurex 21481052892 49450681 IBMFc1
7 QUOTExEQUITY Eurex International Business Machines Equity Future Continuation 2, Equity Future, USD, Eurex 21481053949 50092347 IBMFc2
8 QUOTExEQUITY Euronext Amsterdam IBM Single Stock Dividend Future Continuation 1, Equity Future, USD, Euronext Amsterdam 21613372305 260213021 IBMDFc1
9 QUOTExEQUITY Eurex International Business Machines Equity Future Continuation 3, Equity Future, USD, Eurex 21481053950 50092348 IBMFc3

The following example demonstrates how to create a search by people query to search CFO's:

import { Search } from '@refinitiv-data/data';

const definition = Search.Definition({
    query: "cfo",
    view: Search.SearchViews.PEOPLE
});

const response = await definition.getData();

console.log(response.data.table);
Response
ISIN RIC IssueDate Currency FaceIssuedTotal CouponRate MaturityDate
0 US459200HG92 459200HG9= 2012-07-30 00:00:00 USD 1000000000 1.875 2022-08-01 00:00:00
1 XS1271665280 US127166528= 2015-08-05 00:00:00 GBP 300000000 2.625 2022-08-05 00:00:00
2 US459200JC60 459200JC6= 2015-11-09 00:00:00 USD 900000000 2.875 2022-11-09 00:00:00
3 XS1944456018 US194445601= 2019-01-31 00:00:00 EUR 1750000000 0.375 2023-01-31 00:00:00
4 XS1143163183 US114316318= 2014-11-26 00:00:00 EUR 1000000000 1.25 2023-05-26 00:00:00
5 US459200HP91 459200HP9= 2013-08-01 00:00:00 USD 1500000000 3.375 2023-08-01 00:00:00
6 US459200HU86 459200HU8= 2014-02-12 00:00:00 USD 2000000000 3.625 2024-02-12 00:00:00
7 US459200JY80 459200JY8= 2019-05-15 00:00:00 USD 3000000000 3 2024-05-15 00:00:00
8 XS1375841233 US137584123= 2016-03-07 00:00:00 EUR 750000000 1.125 2024-09-06 00:00:00
9 XS1944456109 US194445610= 2019-01-31 00:00:00 EUR 1000000000 0.875 2025-01-31 00:00:00

None.