2.0.0 • Published 8 months ago

@factset/sdk-idlookup v2.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
8 months ago

FactSet

ID Lookup client library for JavaScript

API Version npm Apache-2 license

The ID Lookup API is a fuzzy search service that allows users to resolve symbols but are unable to find them elsewhere. The ID Lookup API allows users to search for entities in a wide variety of ways including, but not limited to, tickers, CUSIPs, URLs, a company’s brands, names and descriptions. The API does not require a complete query and will return different lists of results with each additional character, which enables users to iterate and adjust queries to return the desired results. Each search query returns a list of suggestions that can include every entity type offered by the API based on a matching and ranking algorithm.

The API response returns multiple different symbols that map to both internal FactSet identifiers like security or entity IDs as well as external identifiers like exchange tickers, Morningstar symbols and ISINs. This gives users flexibility in mapping identifiers across the FactSet universe.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • SDK version: 2.0.0
  • Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

  • Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/sdk-idlookup@2.0.0

yarn

yarn add @factset/sdk-utils @factset/sdk-idlookup@2.0.0

Usage

  1. Generate authentication credentials.
  2. Setup Node.js environment

    1. Install and activate Node.js >=18. If you're using nvm:

      nvm install 18
      nvm use 18
    2. (optional) Install yarn.

  3. Install dependencies.

  4. Run the following:

!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, FactSetIDLookupApi } = require('@factset/sdk-idlookup');
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 FactSetIDLookupApi();
const dataset = "dataset_example"; // String | Type of dataset.

// Call api endpoint
apiInstance.helper(dataset).then(
  data => {

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

Using a Proxy

To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:

const { ApiClient } = require('@factset/sdk-idlookup');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:password@proxy.example.com:8080');

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/idsearch/v2

ClassMethodHTTP requestDescription
idlookup.FactSetIDLookupApihelperGET /metadata/fields/list-by-datasetHelper endpoint offering a list of supported fields and values to filter a requested dataset.
idlookup.FactSetIDLookupApisearchPOST /lookupSearch functionality to return tickers, company names, and unique identifiers for FactSet data.

Documentation for Models

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.

0.23.0

8 months ago

2.0.0

8 months ago

1.0.0

8 months ago

0.10.1

10 months ago

0.10.0

12 months ago

0.22.0

1 year ago

0.21.4

2 years ago

0.21.3

2 years ago

0.21.2

2 years ago

0.21.1

3 years ago

0.21.0

3 years ago

0.20.0

3 years ago

0.9.1

3 years ago

0.9.0

3 years ago