realtimequotes.InstrumentApi

All URIs are relative to https://api.factset.com/wealth/v3

Method	HTTP request	Description
getInstrumentBackgroundTextList	GET /instrument/backgroundText/list	Background texts of an instrument.
getInstrumentCompliancePropertyListByInstrument	GET /instrument/complianceProperty/listByInstrument	Compliance properties of an instrument.
getInstrumentCompositeGet	GET /instrument/composite/get	Composite instrument and its components.
getInstrumentCouponDayCountConventionTypeList	GET /instrument/coupon/dayCountConvention/type/list	List of day count convention types.
getInstrumentCouponInterestRateTypeList	GET /instrument/coupon/interestRate/type/list	List of interest rate types.
getInstrumentCouponKeyDataGet	GET /instrument/coupon/keyData/get	Interest rate details for selected periods of an interest-bearing instrument.
getInstrumentCouponList	GET /instrument/coupon/list	List of coupons for an interest-bearing instrument.
getInstrumentCrossReferenceGetByISIN	GET /instrument/crossReference/getByISIN	Translate ISIN to instrument.
getInstrumentCrossReferenceGetByWKN	GET /instrument/crossReference/getByWKN	Translate WKN to instrument.
getInstrumentCrossReferenceHistoryGetByISIN	GET /instrument/crossReference/history/getByISIN	ISIN to instrument translation history.
getInstrumentCrossReferenceHistoryGetByWKN	GET /instrument/crossReference/history/getByWKN	WKN to instrument translation history.
getInstrumentExchangeRateGet	GET /instrument/exchangeRate/get	Retrieve an exchange rate instrument identifier.
getInstrumentExchangeRateGetByISOCode	GET /instrument/exchangeRate/getByISOCode	Retrieve an exchange rate instrument identifier.
getInstrumentGet	GET /instrument/get	Basic data for an instrument.
getInstrumentGetByNotation	GET /instrument/getByNotation	Basic data for an instrument.
getInstrumentLegalEntityBackgroundTextList	GET /instrument/legalEntity/backgroundText/list	Role-specific background texts of legal entities related to an instrument.
getInstrumentLegalEntityCompliancePropertyList	GET /instrument/legalEntity/complianceProperty/list	Role-specific compliance properties of legal entities related to an instrument.
getInstrumentMifidGet	GET /instrument/mifid/get	MiFID II data for a financial instrument.
getInstrumentSearchBasic	GET /instrument/search/basic	Basic search for instruments.
getInstrumentSelectionListList	GET /instrument/selectionList/list	Set of custom instrument-level selection lists.
getInstrumentSelectionListListByInstrument	GET /instrument/selectionList/listByInstrument	For each given instrument, returns the instrument-level selection lists of which the instrument is a member.
postInstrumentBackgroundTextTypeList	POST /instrument/backgroundText/type/list	List of background text types for instruments.
postInstrumentBenchmarkList	POST /instrument/benchmark/list	List of benchmarks of a financial instrument.
postInstrumentCategoryList	POST /instrument/category/list	List of categories assigned to a specific instrument the application is entitled to see.
postInstrumentCompliancePropertyList	POST /instrument/complianceProperty/list	List of compliance properties for instruments.
postInstrumentCrossReferenceListByISIN	POST /instrument/crossReference/listByISIN	Translate a list of ISINs to instruments.
postInstrumentCrossReferenceListByWKN	POST /instrument/crossReference/listByWKN	Translate a list of WKNs to instruments.
postInstrumentNotationList	POST /instrument/notation/list	List of active, entitled notations for a set of instruments.
postInstrumentRatingGradeList	POST /instrument/rating/grade/list	List of rating grades for a list of instruments.
postInstrumentSelectionListMembersList	POST /instrument/selectionList/members/list	List of instruments belonging to an instrument-level selection list.

getInstrumentBackgroundTextList

InlineResponse20044 getInstrumentBackgroundTextList(identifier, identifierType, opts)

Background texts of an instrument.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentBackgroundTextList(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20044

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCompliancePropertyListByInstrument

InlineResponse20049 getInstrumentCompliancePropertyListByInstrument(identifier, identifierType, opts)

Compliance properties of an instrument.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentCompliancePropertyListByInstrument(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20049

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCompositeGet

InlineResponse20050 getInstrumentCompositeGet(identifier, identifierType, opts)

Composite instrument and its components.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentCompositeGet(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20050

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCouponDayCountConventionTypeList

InlineResponse20052 getInstrumentCouponDayCountConventionTypeList(opts)

List of day count convention types.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentCouponDayCountConventionTypeList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20052

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCouponInterestRateTypeList

InlineResponse20053 getInstrumentCouponInterestRateTypeList(opts)

List of interest rate types.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentCouponInterestRateTypeList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20053

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCouponKeyDataGet

InlineResponse20054 getInstrumentCouponKeyDataGet(identifier, identifierType, opts)

Interest rate details for selected periods of an interest-bearing instrument.

Interest rate details for selected periods of an interest-bearing instrument; any other instrument yields empty values.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentCouponKeyDataGet(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20054

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCouponList

InlineResponse20051 getInstrumentCouponList(identifier, identifierType, opts)

List of coupons for an interest-bearing instrument.

List of coupons for an interest-bearing instrument; any other instrument yields empty values. The endpoint provides details regarding the coupon period, the respective interest rate, and payable amount (the latter only for instruments with a fixed nominal value). The list of coupons is generally not available for a perpetual, i.e. without a predefined maturity date, interst-bearing instrument. If there is no entitled provider supplying a full list of coupons, the list will be synthesized from summary data available from entitled suppliers (if any). Since the exact product terms are not known, e.g. the handling of holidays and weekends, the list may be imprecise.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentCouponList(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20051

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCrossReferenceGetByISIN

InlineResponse20055 getInstrumentCrossReferenceGetByISIN(isin, opts)

Translate ISIN to instrument.

Translate a given ISIN to the respective most recent instrument identifier, retrieved from the Cross Reference Service.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const isin = "isin_example"; // String | 
const opts = {
  'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};

// Call api endpoint
apiInstance.getInstrumentCrossReferenceGetByISIN(isin, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
isin	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]

Return type

InlineResponse20055

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCrossReferenceGetByWKN

InlineResponse20055 getInstrumentCrossReferenceGetByWKN(wkn, opts)

Translate WKN to instrument.

Translate a given WKN to the respective most recent instrument identifier, retrieved from the Cross Reference Service.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const wkn = "wkn_example"; // String | 
const opts = {
  'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};

// Call api endpoint
apiInstance.getInstrumentCrossReferenceGetByWKN(wkn, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
wkn	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]

Return type

InlineResponse20055

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCrossReferenceHistoryGetByISIN

InlineResponse20058 getInstrumentCrossReferenceHistoryGetByISIN(isin, opts)

ISIN to instrument translation history.

Retrieve the complete translation history of a given ISIN to the respective instrument association from the Cross Reference Service. The results are sorted in descending order, starting with the most recent.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const isin = "isin_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'paginationOffset': 0, // Number | Non-negative number of entries to skip, or 0 (default).
  'paginationLimit': 10 // Number | Non-negative maximum number of entries to return.
};

// Call api endpoint
apiInstance.getInstrumentCrossReferenceHistoryGetByISIN(isin, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
isin	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
paginationOffset	Number	Non-negative number of entries to skip, or 0 (default).	[optional] [default to 0]
paginationLimit	Number	Non-negative maximum number of entries to return.	[optional] [default to 10]

Return type

InlineResponse20058

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentCrossReferenceHistoryGetByWKN

InlineResponse20058 getInstrumentCrossReferenceHistoryGetByWKN(wkn, opts)

WKN to instrument translation history.

Retrieve the complete translation history of a given WKN to the respective instrument association from the Cross Reference Service. The results are sorted in descending order, starting with the most recent.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const wkn = "wkn_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'paginationOffset': 0, // Number | Non-negative number of entries to skip, or 0 (default).
  'paginationLimit': 10 // Number | Non-negative maximum number of entries to return.
};

// Call api endpoint
apiInstance.getInstrumentCrossReferenceHistoryGetByWKN(wkn, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
wkn	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
paginationOffset	Number	Non-negative number of entries to skip, or 0 (default).	[optional] [default to 0]
paginationLimit	Number	Non-negative maximum number of entries to return.	[optional] [default to 10]

Return type

InlineResponse20058

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentExchangeRateGet

InlineResponse20059 getInstrumentExchangeRateGet(target, source, opts)

Retrieve an exchange rate instrument identifier.

Retrieve an exchange rate instrument identifier using the identifier of the main currencies represented by that exchange rate. An error is returned if one of the provided parameters is invalid or if no instrument is associated with the given combination of parameters.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const target = 3.4; // Number | 
const source = 3.4; // Number | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentExchangeRateGet(target, source, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
target	Number
source	Number
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20059

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentExchangeRateGetByISOCode

InlineResponse20059 getInstrumentExchangeRateGetByISOCode(target, source, opts)

Retrieve an exchange rate instrument identifier.

Retrieve an exchange rate instrument identifier using the ISO 4217 code of the main currencies represented by that exchange rate. An error is returned if one of the provided parameters is invalid or if no instrument is associated with the given combination of parameters.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const target = "target_example"; // String | 
const source = "source_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentExchangeRateGetByISOCode(target, source, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
target	String
source	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20059

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentGet

InlineResponse20042 getInstrumentGet(identifier, identifierType, opts)

Basic data for an instrument.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentGet(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20042

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentGetByNotation

InlineResponse20043 getInstrumentGetByNotation(id, opts)

Basic data for an instrument.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const id = "id_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentGetByNotation(id, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
id	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20043

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentLegalEntityBackgroundTextList

InlineResponse20060 getInstrumentLegalEntityBackgroundTextList(identifier, identifierType, opts)

Role-specific background texts of legal entities related to an instrument.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentLegalEntityBackgroundTextList(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20060

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentLegalEntityCompliancePropertyList

InlineResponse20061 getInstrumentLegalEntityCompliancePropertyList(identifier, identifierType, opts)

Role-specific compliance properties of legal entities related to an instrument.

Role-specic compliance properties of legal entities related to an instrument.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentLegalEntityCompliancePropertyList(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20061

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentMifidGet

InlineResponse20062 getInstrumentMifidGet(identifier, identifierType, opts)

MiFID II data for a financial instrument.

MiFID II data for a specified financial instrument. The instruments governed by MiFID II are called "investment products".

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getInstrumentMifidGet(identifier, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifier	String
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]

Return type

InlineResponse20062

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentSearchBasic

InlineResponse20097 getInstrumentSearchBasic(searchValue, opts)

Basic search for instruments.

Search for instruments whose ISIN, specified NSINs, or name match the search value according to a tolerant full-text match algorithm. Better matching results appear in the response before less relevant matches.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const searchValue = "searchValue_example"; // String | 
const opts = {
  'nsins': ["null"], // [String] | 
  'assetClass': "assetClass_example", // String | 
  'onlyActive': true, // Boolean | 
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example", // String | 
  'paginationOffset': 0, // Number | Non-negative number of entries to skip, or 0 (default).
  'paginationLimit': 20 // Number | Non-negative maximum number of entries to return.
};

// Call api endpoint
apiInstance.getInstrumentSearchBasic(searchValue, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
searchValue	String
nsins	[String]		[optional]
assetClass	String		[optional]
onlyActive	Boolean		[optional] [default to true]
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
language	String		[optional]
paginationOffset	Number	Non-negative number of entries to skip, or 0 (default).	[optional] [default to 0]
paginationLimit	Number	Non-negative maximum number of entries to return.	[optional] [default to 20]

Return type

InlineResponse20097

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentSelectionListList

InlineResponse20065 getInstrumentSelectionListList(opts)

Set of custom instrument-level selection lists.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};

// Call api endpoint
apiInstance.getInstrumentSelectionListList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]

Return type

InlineResponse20065

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstrumentSelectionListListByInstrument

InlineResponse20066 getInstrumentSelectionListListByInstrument(identifiers, identifierType, opts)

For each given instrument, returns the instrument-level selection lists of which the instrument is a member.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const identifiers = ["null"]; // [String] | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};

// Call api endpoint
apiInstance.getInstrumentSelectionListListByInstrument(identifiers, identifierType, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
identifiers	[String]
identifierType	String
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]

Return type

InlineResponse20066

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

postInstrumentBackgroundTextTypeList

InlineResponse20045 postInstrumentBackgroundTextTypeList(opts)

List of background text types for instruments.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'postInstrumentBackgroundTextTypeListRequest': new realtimequotes.PostInstrumentBackgroundTextTypeListRequest() // PostInstrumentBackgroundTextTypeListRequest | Request Body
};

// Call api endpoint
apiInstance.postInstrumentBackgroundTextTypeList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentBackgroundTextTypeListRequest	PostInstrumentBackgroundTextTypeListRequest	Request Body	[optional]

Return type

InlineResponse20045

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postInstrumentBenchmarkList

InlineResponse20046 postInstrumentBenchmarkList(opts)

List of benchmarks of a financial instrument.

Provides a list of benchmark notations for a selected financial instrument, optionally restricted to specific benchmark types.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'postInstrumentBenchmarkListRequest': new realtimequotes.PostInstrumentBenchmarkListRequest() // PostInstrumentBenchmarkListRequest | Request Body
};

// Call api endpoint
apiInstance.postInstrumentBenchmarkList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentBenchmarkListRequest	PostInstrumentBenchmarkListRequest	Request Body	[optional]

Return type

InlineResponse20046

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postInstrumentCategoryList

InlineResponse20047 postInstrumentCategoryList(opts)

List of categories assigned to a specific instrument the application is entitled to see.

List of categories assigned to a specific instrument the application is entitled to see. Optionally it is possible to restrict the output to only list those for a specific category dataset.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'postInstrumentCategoryListRequest': new realtimequotes.PostInstrumentCategoryListRequest() // PostInstrumentCategoryListRequest | Request Body
};

// Call api endpoint
apiInstance.postInstrumentCategoryList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentCategoryListRequest	PostInstrumentCategoryListRequest	Request Body	[optional]

Return type

InlineResponse20047

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postInstrumentCompliancePropertyList

InlineResponse20048 postInstrumentCompliancePropertyList(opts)

List of compliance properties for instruments.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'postInstrumentCompliancePropertyListRequest': new realtimequotes.PostInstrumentCompliancePropertyListRequest() // PostInstrumentCompliancePropertyListRequest | Request Body
};

// Call api endpoint
apiInstance.postInstrumentCompliancePropertyList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentCompliancePropertyListRequest	PostInstrumentCompliancePropertyListRequest	Request Body	[optional]

Return type

InlineResponse20048

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postInstrumentCrossReferenceListByISIN

InlineResponse20056 postInstrumentCrossReferenceListByISIN(postInstrumentCrossReferenceListByISINRequest)

Translate a list of ISINs to instruments.

Translate a given list of ISINs to the respective most recent instrument identifiers, retrieved from the Cross Reference Service.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const postInstrumentCrossReferenceListByISINRequest = new realtimequotes.PostInstrumentCrossReferenceListByISINRequest(); // PostInstrumentCrossReferenceListByISINRequest | Request Body

// Call api endpoint
apiInstance.postInstrumentCrossReferenceListByISIN(postInstrumentCrossReferenceListByISINRequest).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentCrossReferenceListByISINRequest	PostInstrumentCrossReferenceListByISINRequest	Request Body

Return type

InlineResponse20056

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postInstrumentCrossReferenceListByWKN

InlineResponse20057 postInstrumentCrossReferenceListByWKN(postInstrumentCrossReferenceListByWKNRequest)

Translate a list of WKNs to instruments.

Translate a given list of WKNs to the respective most recent instrument identifiers, retrieved from the Cross Reference Service.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const postInstrumentCrossReferenceListByWKNRequest = new realtimequotes.PostInstrumentCrossReferenceListByWKNRequest(); // PostInstrumentCrossReferenceListByWKNRequest | Request Body

// Call api endpoint
apiInstance.postInstrumentCrossReferenceListByWKN(postInstrumentCrossReferenceListByWKNRequest).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentCrossReferenceListByWKNRequest	PostInstrumentCrossReferenceListByWKNRequest	Request Body

Return type

InlineResponse20057

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postInstrumentNotationList

InlineResponse20063 postInstrumentNotationList(opts)

List of active, entitled notations for a set of instruments.

List of active, entitled notations for a set of instruments. By default the list of notations (per instrument) is sorted descending by the trading volume, averaged over one month. All identifiers used as parameters must be valid and entitled.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'postInstrumentNotationListRequest': new realtimequotes.PostInstrumentNotationListRequest() // PostInstrumentNotationListRequest | Request Body
};

// Call api endpoint
apiInstance.postInstrumentNotationList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentNotationListRequest	PostInstrumentNotationListRequest	Request Body	[optional]

Return type

InlineResponse20063

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postInstrumentRatingGradeList

InlineResponse20064 postInstrumentRatingGradeList(opts)

List of rating grades for a list of instruments.

List of rating grades for a list of instruments. The list can be restricted to rating grades belonging to particular rating systems.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'postInstrumentRatingGradeListRequest': new realtimequotes.PostInstrumentRatingGradeListRequest() // PostInstrumentRatingGradeListRequest | Request Body
};

// Call api endpoint
apiInstance.postInstrumentRatingGradeList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentRatingGradeListRequest	PostInstrumentRatingGradeListRequest	Request Body	[optional]

Return type

InlineResponse20064

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postInstrumentSelectionListMembersList

InlineResponse20067 postInstrumentSelectionListMembersList(opts)

List of instruments belonging to an instrument-level selection list.

Example

Important

The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, InstrumentApi } = require('@factset/sdk-realtimequotes');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new InstrumentApi();
const opts = {
  'postInstrumentSelectionListMembersListRequest': new realtimequotes.PostInstrumentSelectionListMembersListRequest() // PostInstrumentSelectionListMembersListRequest | Request Body
};

// Call api endpoint
apiInstance.postInstrumentSelectionListMembersList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
postInstrumentSelectionListMembersListRequest	PostInstrumentSelectionListMembersListRequest	Request Body	[optional]

Return type

InlineResponse20067

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

InstrumentApi.md

Latest commit

History

InstrumentApi.md

File metadata and controls

realtimequotes.InstrumentApi

getInstrumentBackgroundTextList

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCompliancePropertyListByInstrument

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCompositeGet

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCouponDayCountConventionTypeList

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCouponInterestRateTypeList

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCouponKeyDataGet

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCouponList

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCrossReferenceGetByISIN

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCrossReferenceGetByWKN

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCrossReferenceHistoryGetByISIN

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getInstrumentCrossReferenceHistoryGetByWKN

Example

Example Code