@factset/sdk-symbology v3.0.0
Symbology client library for JavaScript
The FactSet Symbology API provides symbol resolution services, allowing clients to translate market identifiers into various symbology types such as, FactSet Permanent Identifiers, CUSIP, ISIN, SEDOL, Tickers, and LEIs. Factset's Symbology API sits at the center of its hub-and-spoke data model, enabling you to quickly harmonize the expanding catalog of Content APIs.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 3.3.0
- Package version: 3.0.0
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/sdk-symbology@3.0.0
yarn
yarn add @factset/sdk-utils @factset/sdk-symbology@3.0.0
Usage
- Generate authentication credentials.
Setup Node.js environment
Install and activate Node.js >=14. If you're using nvm:
nvm install 16 nvm use 16
(optional) Install yarn.
- Run the following:
const { ApiClient, HistoricalIdentifierResolutionApi } = require('@factset/sdk-symbology');
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 HistoricalIdentifierResolutionApi();
const identifierResolutionHistoricalRequest = new symbology.IdentifierResolutionHistoricalRequest(); // IdentifierResolutionHistoricalRequest | Request Body for Historical Identifier Resolution.
// Call api endpoint
apiInstance.batchHistoricalIdentifierResolution(identifierResolutionHistoricalRequest).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/content
Class | Method | HTTP request | Description |
---|---|---|---|
symbology.HistoricalIdentifierResolutionApi | batchHistoricalIdentifierResolution | POST /symbology/v3/historical-identifier-resolution | Returns the specified historical output identifiers for the given input identifier. |
symbology.HistoricalIdentifierResolutionApi | historicalIdentifierResolution | GET /symbology/v3/historical-identifier-resolution | Returns the specified historical output identifiers for the given input identifier. |
symbology.IdentifierResolutionApi | batchIdentifierResolution | POST /symbology/v3/identifier-resolution | Returns the specified output identifiers for the given input identifier. |
symbology.IdentifierResolutionApi | identifierResolution | GET /symbology/v3/identifier-resolution | Returns the specified output identifiers for the specified input identifier. |
Documentation for Models
- symbology.ErrorObject
- symbology.ErrorObjectLinks
- symbology.ErrorResponse
- symbology.ErrorResponseHistorical
- symbology.ErrorResponseSubErrors
- symbology.GetHistoricalInputSymbolType
- symbology.GetInputSymbolType
- symbology.IdentifierResolution
- symbology.IdentifierResolutionHistorical
- symbology.IdentifierResolutionHistoricalRequest
- symbology.IdentifierResolutionHistoricalRequestBody
- symbology.IdentifierResolutionHistoricalResponse
- symbology.IdentifierResolutionRequest
- symbology.IdentifierResolutionResponse
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2022 FactSet Research Systems Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
4 months ago
8 months ago
7 months ago
8 months ago
10 months ago
10 months ago
7 months ago
8 months ago
11 months ago
11 months ago
12 months ago
11 months ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago