NotationApi.md

realtimequotes.NotationApi

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

Method	HTTP request	Description
getNotationCrossReferenceFactSetIdentifierGet	GET /notation/crossReference/factSetIdentifier/get	Retrieve FactSet identifiers for a given notation.
getNotationCrossReferenceGetByFactSetMarketSymbol	GET /notation/crossReference/getByFactSetMarketSymbol	Translate a FactSet market symbol to a notation.
getNotationGet	GET /notation/get	Basic data for a notation.
getNotationKeyFiguresMonth1Get	GET /notation/keyFigures/month/1/get	End-of-day (EOD) key figures for the time range of one month.
getNotationKeyFiguresMonth1List	GET /notation/keyFigures/month/1/list	End-of-day (EOD) key figures for the time range of one month, for a list of notations.
getNotationKeyFiguresMonth3Get	GET /notation/keyFigures/month/3/get	End-of-day (EOD) key figures for the time range of three months.
getNotationKeyFiguresMonth3List	GET /notation/keyFigures/month/3/list	End-of-day (EOD) key figures for the time range of three months, for a list of notations.
getNotationKeyFiguresMonth6Get	GET /notation/keyFigures/month/6/get	End-of-day (EOD) key figures for the time range of six months.
getNotationKeyFiguresMonth6List	GET /notation/keyFigures/month/6/list	End-of-day (EOD) key figures for the time range of six months, for a list of notations.
getNotationKeyFiguresTradingDayAverageGet	GET /notation/keyFigures/tradingDay/average/get	Average end-of-day (EOD) key figures for different trading days periods.
getNotationKeyFiguresWeek1Get	GET /notation/keyFigures/week/1/get	End-of-day (EOD) key figures for the time range of one week.
getNotationKeyFiguresWeek1List	GET /notation/keyFigures/week/1/list	End-of-day (EOD) key figures for the time range of one week, for a list of notations.
getNotationKeyFiguresYear10Get	GET /notation/keyFigures/year/10/get	End-of-day (EOD) key figures for the time range of ten years.
getNotationKeyFiguresYear10List	GET /notation/keyFigures/year/10/list	End-of-day (EOD) key figures for the time range of ten years, for a list of notations.
getNotationKeyFiguresYear1Get	GET /notation/keyFigures/year/1/get	End-of-day (EOD) key figures for the time range of one year.
getNotationKeyFiguresYear1List	GET /notation/keyFigures/year/1/list	End-of-day (EOD) key figures for the time range of one year, for a list of notations.
getNotationKeyFiguresYear3Get	GET /notation/keyFigures/year/3/get	End-of-day (EOD) key figures for the time range of three years.
getNotationKeyFiguresYear3List	GET /notation/keyFigures/year/3/list	End-of-day (EOD) key figures for the time range of three years, for a list of notations.
getNotationKeyFiguresYear5Get	GET /notation/keyFigures/year/5/get	End-of-day (EOD) key figures for the time range of five years.
getNotationKeyFiguresYear5List	GET /notation/keyFigures/year/5/list	End-of-day (EOD) key figures for the time range of five years, for a list of notations.
getNotationKeyFiguresYear7Get	GET /notation/keyFigures/year/7/get	End-of-day (EOD) key figures for the time range of seven years.
getNotationKeyFiguresYear7List	GET /notation/keyFigures/year/7/list	End-of-day (EOD) key figures for the time range of seven years, for a list of notations.
getNotationKeyFiguresYearToDateGet	GET /notation/keyFigures/yearToDate/get	End-of-day (EOD) key figures for the time range year-to-date (YTD)..
getNotationKeyFiguresYearToDateList	GET /notation/keyFigures/yearToDate/list	End-of-day (EOD) key figures for the time range year-to-date (YTD), for a list of notations..
getNotationList	GET /notation/list	Basic data for a list of notations.
getNotationSearchBasic	GET /notation/search/basic	Basic search for notations.
getNotationSelectionListList	GET /notation/selectionList/list	Set of custom notation-level selection lists.
getNotationSelectionListListByNotation	GET /notation/selectionList/listByNotation	For each given notation, returns the notation-level selection lists of which the notation is a member.
getNotationStatusGet	GET /notation/status/get	Intraday trading status of a notation.
postNotationCategoryList	POST /notation/category/list	List of categories assigned to a specific notation the application is entitled to see.
postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifier	POST /notation/crossReference/factSetIdentifier/listByFactSetIdentifier	Retrieve a list of notations for a given FactSet identifier.
postNotationCrossReferenceFactSetIdentifierListByInstrument	POST /notation/crossReference/factSetIdentifier/listByInstrument	Retrieve a list of FactSet identifiers for a given instrument.
postNotationCrossReferenceListByISIN	POST /notation/crossReference/listByISIN	List of entitled notations.
postNotationCrossReferenceListByInstrument	POST /notation/crossReference/listByInstrument	List of entitled notations.
postNotationCrossReferenceListBySymbol	POST /notation/crossReference/listBySymbol	List of entitled notations.
postNotationMarketList	POST /notation/market/list	List of markets with entitled notations.
postNotationSearchByText	POST /notation/searchByText	Text-based search for notations.
postNotationSelectionListMembersList	POST /notation/selectionList/members/list	List of notations belonging to a notation-level selection list.

getNotationCrossReferenceFactSetIdentifierGet

InlineResponse20075 getNotationCrossReferenceFactSetIdentifierGet(identifier, identifierType, opts)

Retrieve FactSet identifiers for a given notation.

<p>Retrieve FactSet identifiers for a given notation. Security and listing-level identifiers are always included, regional level identifiers are included, if available.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationCrossReferenceFactSetIdentifierGet(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]

Return type

InlineResponse20075

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationCrossReferenceGetByFactSetMarketSymbol

InlineResponse20071 getNotationCrossReferenceGetByFactSetMarketSymbol(factSetMarketSymbol, opts)

Translate a FactSet market symbol to a notation.

Translate a FactSet market symbol to a notation. This symbol is also known as TICKER_EXCHANGE.

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, NotationApi } = 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 NotationApi();
const factSetMarketSymbol = "factSetMarketSymbol_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.getNotationCrossReferenceGetByFactSetMarketSymbol(factSetMarketSymbol, opts).then(
  data => {

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

Parameters

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

Return type

InlineResponse20071

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationGet

InlineResponse20068 getNotationGet(identifier, identifierType, opts)

Basic data for a notation.

Basic data for a notation.

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, NotationApi } = 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 NotationApi();
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.getNotationGet(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

InlineResponse20068

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresMonth1Get

InlineResponse20080 getNotationKeyFiguresMonth1Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of one month.

End-of-day (EOD) key figures for the time range of one month.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresMonth1Get(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]

Return type

InlineResponse20080

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresMonth1List

InlineResponse20081 getNotationKeyFiguresMonth1List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of one month, for a list of notations.

End-of-day (EOD) key figures for the time range of one month, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresMonth1List(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

InlineResponse20081

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresMonth3Get

InlineResponse20078 getNotationKeyFiguresMonth3Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of three months.

End-of-day (EOD) key figures for the time range of three months.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresMonth3Get(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]

Return type

InlineResponse20078

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresMonth3List

InlineResponse20079 getNotationKeyFiguresMonth3List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of three months, for a list of notations.

End-of-day (EOD) key figures for the time range of three months, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresMonth3List(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

InlineResponse20079

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresMonth6Get

InlineResponse20078 getNotationKeyFiguresMonth6Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of six months.

End-of-day (EOD) key figures for the time range of six months.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresMonth6Get(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]

Return type

InlineResponse20078

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresMonth6List

InlineResponse20079 getNotationKeyFiguresMonth6List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of six months, for a list of notations.

End-of-day (EOD) key figures for the time range of six months, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresMonth6List(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

InlineResponse20079

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresTradingDayAverageGet

InlineResponse20084 getNotationKeyFiguresTradingDayAverageGet(identifier, identifierType, opts)

Average end-of-day (EOD) key figures for different trading days periods.

Average end-of-day (EOD) key figures for different trading days periods. A trading day is a calendar day on that trading of the notation was possible.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresTradingDayAverageGet(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]

Return type

InlineResponse20084

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresWeek1Get

InlineResponse20080 getNotationKeyFiguresWeek1Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of one week.

End-of-day (EOD) key figures for the time range of one week.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresWeek1Get(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]

Return type

InlineResponse20080

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresWeek1List

InlineResponse20081 getNotationKeyFiguresWeek1List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of one week, for a list of notations.

End-of-day (EOD) key figures for the time range of one week, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresWeek1List(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

InlineResponse20081

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear10Get

InlineResponse20078 getNotationKeyFiguresYear10Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of ten years.

End-of-day (EOD) key figures for the time range of ten years.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresYear10Get(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]

Return type

InlineResponse20078

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear10List

InlineResponse20079 getNotationKeyFiguresYear10List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of ten years, for a list of notations.

End-of-day (EOD) key figures for the time range of ten years, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresYear10List(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

InlineResponse20079

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear1Get

InlineResponse20080 getNotationKeyFiguresYear1Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of one year.

End-of-day (EOD) key figures for the time range of one year.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresYear1Get(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]

Return type

InlineResponse20080

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear1List

InlineResponse20081 getNotationKeyFiguresYear1List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of one year, for a list of notations.

End-of-day (EOD) key figures for the time range of one year, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresYear1List(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

InlineResponse20081

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear3Get

InlineResponse20078 getNotationKeyFiguresYear3Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of three years.

End-of-day (EOD) key figures for the time range of three years.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresYear3Get(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]

Return type

InlineResponse20078

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear3List

InlineResponse20079 getNotationKeyFiguresYear3List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of three years, for a list of notations.

End-of-day (EOD) key figures for the time range of three years, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresYear3List(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

InlineResponse20079

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear5Get

InlineResponse20078 getNotationKeyFiguresYear5Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of five years.

End-of-day (EOD) key figures for the time range of five years.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresYear5Get(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]

Return type

InlineResponse20078

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear5List

InlineResponse20079 getNotationKeyFiguresYear5List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of five years, for a list of notations.

End-of-day (EOD) key figures for the time range of five years, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresYear5List(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

InlineResponse20079

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear7Get

InlineResponse20078 getNotationKeyFiguresYear7Get(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range of seven years.

End-of-day (EOD) key figures for the time range of seven years.

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresYear7Get(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]

Return type

InlineResponse20078

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYear7List

InlineResponse20079 getNotationKeyFiguresYear7List(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range of seven years, for a list of notations.

End-of-day (EOD) key figures for the time range of seven years, for a list of notations.

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresYear7List(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

InlineResponse20079

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYearToDateGet

InlineResponse20082 getNotationKeyFiguresYearToDateGet(identifier, identifierType, opts)

End-of-day (EOD) key figures for the time range year-to-date (YTD)..

End-of-day (EOD) key figures for the time range year-to-date (YTD). The time range YTD begins with the last trading day of the previous calendar year for which EOD prices are available and ends with the most recent trading day of the current calendar year for which EOD prices are available..

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, NotationApi } = 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 NotationApi();
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.
};

// Call api endpoint
apiInstance.getNotationKeyFiguresYearToDateGet(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]

Return type

InlineResponse20082

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationKeyFiguresYearToDateList

InlineResponse20083 getNotationKeyFiguresYearToDateList(identifiers, identifierType, opts)

End-of-day (EOD) key figures for the time range year-to-date (YTD), for a list of notations..

End-of-day (EOD) key figures for the time range year-to-date (YTD), for a list of notations. The time range YTD begins with the last trading day of the previous calendar year for which EOD prices are available and ends with the most recent tradingday of the current calendar year for which EOD prices are available..

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, NotationApi } = 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 NotationApi();
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.getNotationKeyFiguresYearToDateList(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

InlineResponse20083

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationList

InlineResponse20069 getNotationList(identifiers, identifierType, opts)

Basic data for a list of notations.

Basic data for a list of notations.

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, NotationApi } = 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 NotationApi();
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.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getNotationList(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]
language	String		[optional]

Return type

InlineResponse20069

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationSearchBasic

InlineResponse20098 getNotationSearchBasic(searchValue, opts)

Basic search for notations.

Search for a notation whose ISIN, specified NSINs, name, or symbol match the search value according to a tolerant full-text match algorithm. If more than one notation of an instrument matches, only the notation with the highest monetary trading volume, averaged over one month, is considered. Better matching results appear in the response before less relevant matches. If the parameter popularity is set to true, the popularity of the notation is the primary sort criterion. Popularity is affected mostly by the request frequency of the notation.

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, NotationApi } = 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 NotationApi();
const searchValue = "searchValue_example"; // String | 
const opts = {
  'nsins': ["null"], // [String] | 
  'assetClass': "assetClass_example", // String | 
  'onlyActive': true, // Boolean | 
  'popularity': false, // 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.getNotationSearchBasic(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]
popularity	Boolean		[optional] [default to false]
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

InlineResponse20098

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationSelectionListList

InlineResponse20065 getNotationSelectionListList(opts)

Set of custom notation-level selection lists.

Set of custom notation-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, NotationApi } = 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 NotationApi();
const opts = {
  'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};

// Call api endpoint
apiInstance.getNotationSelectionListList(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

getNotationSelectionListListByNotation

InlineResponse20086 getNotationSelectionListListByNotation(identifiers, identifierType, opts)

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

For each given notation, returns the notation-level selection lists of which the notation 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, NotationApi } = 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 NotationApi();
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.getNotationSelectionListListByNotation(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

InlineResponse20086

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotationStatusGet

InlineResponse20088 getNotationStatusGet(identifier, identifierType, opts)

Intraday trading status of a notation.

Intraday trading status of a notation.<br>The endpoint is subscribable to provide push updates. See attribute `_subscriptionMinimalInterval` for valid update rates.

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, NotationApi } = 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 NotationApi();
const identifier = "identifier_example"; // String | 
const identifierType = "identifierType_example"; // String | 
const opts = {
  'quality': "'DLY'", // String | 
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'subscriptionMinimumInterval': 5000 // Number | Minimum number of milliseconds at which updates are sent.
};

// Call api endpoint
apiInstance.getNotationStatusGet(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
quality	String		[optional] [default to 'DLY']
attributes	[String]	Limit the attributes returned in the response to the specified set.	[optional]
subscriptionMinimumInterval	Number	Minimum number of milliseconds at which updates are sent.	[optional] [default to 5000]

Return type

InlineResponse20088

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

postNotationCategoryList

InlineResponse20070 postNotationCategoryList(opts)

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

List of categories assigned to a specific notation 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, NotationApi } = 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 NotationApi();
const opts = {
  'postNotationCategoryListRequest': new realtimequotes.PostNotationCategoryListRequest() // PostNotationCategoryListRequest | Request Body
};

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

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

Parameters

Name	Type	Description	Notes
postNotationCategoryListRequest	PostNotationCategoryListRequest	Request Body	[optional]

Return type

InlineResponse20070

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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

postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifier

InlineResponse20076 postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifier(postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest)

Retrieve a list of notations for a given FactSet identifier.

<p>Retrieve a list of notations for a given FactSet identifier, grouped by regional identifiers, if available. Listings without a regional identifier are grouped at the end of the response.</p><p>The notation corresponding to the security's primary listing has the attributes <big><tt>regional.isPrimary</tt></big> and <big><tt>regional.listing.isPrimary</tt></big> both set to true.The security's primary listing might not be among the results depending on the entitlement.</p><p>See the group description for more information about the security's primary listing.</p>

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, NotationApi } = 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 NotationApi();
const postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest = new realtimequotes.PostNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest(); // PostNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest | Request Body

// Call api endpoint
apiInstance.postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifier(postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest).then(
  data => {

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

Parameters

Name	Type	Description	Notes
postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest	PostNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest	Request Body

Return type

InlineResponse20076

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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

postNotationCrossReferenceFactSetIdentifierListByInstrument

InlineResponse20077 postNotationCrossReferenceFactSetIdentifierListByInstrument(postNotationCrossReferenceFactSetIdentifierListByInstrumentRequest)

Retrieve a list of FactSet identifiers for a given instrument.

<p>Retrieve a list of FactSet identifiers for a given instrument, grouped by regional identifiers, if available. Listings without a regional identifier are grouped at the end of the response.</p><p>The notation corresponding to the security's primary listing has the attributes <big><tt>regional.isPrimary</tt></big> and <big><tt>regional.listing.isPrimary</tt></big> both set to true.The security's primary listing might not be among the results depending on the entitlement.</p><p>The result contains only notations that have at least one FactSet identifier (see <big><tt>listing.permanentIdentifier</tt></big>, <big><tt>listing.tickerExchange</tt></big>).</p><p>See the group description for more information about the security's primary listing.</p>

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, NotationApi } = 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 NotationApi();
const postNotationCrossReferenceFactSetIdentifierListByInstrumentRequest = new realtimequotes.PostNotationCrossReferenceFactSetIdentifierListByInstrumentRequest(); // PostNotationCrossReferenceFactSetIdentifierListByInstrumentRequest | Request Body

// Call api endpoint
apiInstance.postNotationCrossReferenceFactSetIdentifierListByInstrument(postNotationCrossReferenceFactSetIdentifierListByInstrumentRequest).then(
  data => {

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

Parameters

Name	Type	Description	Notes
postNotationCrossReferenceFactSetIdentifierListByInstrumentRequest	PostNotationCrossReferenceFactSetIdentifierListByInstrumentRequest	Request Body

Return type

InlineResponse20077

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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

postNotationCrossReferenceListByISIN

InlineResponse20073 postNotationCrossReferenceListByISIN(opts)

List of entitled notations.

List of entitled notations.

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, NotationApi } = 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 NotationApi();
const opts = {
  'postNotationCrossReferenceListByISINRequest': new realtimequotes.PostNotationCrossReferenceListByISINRequest() // PostNotationCrossReferenceListByISINRequest | Request Body
};

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

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

Parameters

Name	Type	Description	Notes
postNotationCrossReferenceListByISINRequest	PostNotationCrossReferenceListByISINRequest	Request Body	[optional]

Return type

InlineResponse20073

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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

postNotationCrossReferenceListByInstrument

InlineResponse20072 postNotationCrossReferenceListByInstrument(opts)

List of entitled notations.

List of entitled notations.

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, NotationApi } = 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 NotationApi();
const opts = {
  'postNotationCrossReferenceListByInstrumentRequest': new realtimequotes.PostNotationCrossReferenceListByInstrumentRequest() // PostNotationCrossReferenceListByInstrumentRequest | Request Body
};

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

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

Parameters

Name	Type	Description	Notes
postNotationCrossReferenceListByInstrumentRequest	PostNotationCrossReferenceListByInstrumentRequest	Request Body	[optional]

Return type

InlineResponse20072

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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

postNotationCrossReferenceListBySymbol

InlineResponse20074 postNotationCrossReferenceListBySymbol(opts)

List of entitled notations.

List of entitled notations. Symbols are not globally unique; therefore, a given symbol interpreted in different markets might refer to different 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, NotationApi } = 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 NotationApi();
const opts = {
  'postNotationCrossReferenceListBySymbolRequest': new realtimequotes.PostNotationCrossReferenceListBySymbolRequest() // PostNotationCrossReferenceListBySymbolRequest | Request Body
};

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

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

Parameters

Name	Type	Description	Notes
postNotationCrossReferenceListBySymbolRequest	PostNotationCrossReferenceListBySymbolRequest	Request Body	[optional]

Return type

InlineResponse20074

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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

postNotationMarketList

InlineResponse20085 postNotationMarketList(opts)

List of markets with entitled notations.

List of markets with entitled notations. The list contains only markets with at least one active and entitled notation. 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, NotationApi } = 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 NotationApi();
const opts = {
  'postNotationMarketListRequest': new realtimequotes.PostNotationMarketListRequest() // PostNotationMarketListRequest | Request Body
};

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

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

Parameters

Name	Type	Description	Notes
postNotationMarketListRequest	PostNotationMarketListRequest	Request Body	[optional]

Return type

InlineResponse20085

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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

postNotationSearchByText

InlineResponse20099 postNotationSearchByText(postNotationSearchByTextRequest)

Text-based search for notations.

Text-based search for notations in selected identifier and name attributes according to a tolerant full-text match algorithm. The results satisfy all selected filters; sorting by various attributes is possible. If more than one notation of an instrument matches, only the notation with the best market priority (according to the parameter `market.priority`) or, in the absence of market priorities, only the notation with the highest trading volume, averaged over one month, is considered. 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, NotationApi } = 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 NotationApi();
const postNotationSearchByTextRequest = new realtimequotes.PostNotationSearchByTextRequest(); // PostNotationSearchByTextRequest | Request Body

// Call api endpoint
apiInstance.postNotationSearchByText(postNotationSearchByTextRequest).then(
  data => {

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

Parameters

Name	Type	Description	Notes
postNotationSearchByTextRequest	PostNotationSearchByTextRequest	Request Body

Return type

InlineResponse20099

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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

postNotationSelectionListMembersList

InlineResponse20087 postNotationSelectionListMembersList(opts)

List of notations belonging to a notation-level selection list.

List of notations belonging to a notation-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, NotationApi } = 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 NotationApi();
const opts = {
  'postNotationSelectionListMembersListRequest': new realtimequotes.PostNotationSelectionListMembersListRequest() // PostNotationSelectionListMembersListRequest | Request Body
};

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

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

Parameters

Name	Type	Description	Notes
postNotationSelectionListMembersListRequest	PostNotationSelectionListMembersListRequest	Request Body	[optional]

Return type

InlineResponse20087

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

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