# @factset/sdk-idlookup

> ID Lookup client library for JavaScript

Latest version **2.0.2** (published 2026-06-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @factset/sdk-idlookup
pnpm add @factset/sdk-idlookup
yarn add @factset/sdk-idlookup
bun add @factset/sdk-idlookup
```

## Health

**Score 50/100 (C)** — status: active.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2026-06-17 |
| First published | 2022-02-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18 |
| Dependencies | 3 |
| Unpacked size | 128.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 56 |
| Author | FactSet Research Systems |
| Maintainers | fds, tsouthmaydfds, enterprisesdk, fbecker-fds |
| Keywords | FactSet, API, SDK |

## Links

- npm: https://www.npmjs.com/package/@factset/sdk-idlookup
- Repository: https://github.com/factset/enterprise-sdk
- Homepage: https://developer.factset.com/
- Issues: https://developer.factset.com/api-catalog/id-lookup-api#report-issue
- npm.io page: https://npm.io/package/@factset/sdk-idlookup

## Dependencies (3)

- [superagent](https://npm.io/package/superagent.md) ^9.0.0
- [proxy-agent](https://npm.io/package/proxy-agent.md) ^6.0.0
- [@factset/sdk-utils](https://npm.io/package/@factset/sdk-utils.md) ^2.0.0

## Recent versions

- 2.0.2 (latest) — 2026-06-17
- 0.23.2 (v1) — 2026-06-17
- 2.0.1 — 2025-03-06
- 0.23.1 — 2025-03-06
- 2.0.0 — 2024-11-01
- 0.23.0 — 2024-11-01
- 1.0.0 — 2024-10-30
- 0.10.1 — 2024-08-30
- 0.10.0 — 2024-07-12
- 0.22.0 — 2024-01-16
- 0.21.4 — 2023-10-25
- 0.21.3 — 2023-08-30
- 0.21.2 — 2023-06-06
- 0.21.1 — 2022-08-31
- 0.21.0 — 2022-07-21
- … 3 more at https://npm.io/package/@factset/sdk-idlookup/versions

## README

[![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)

# ID Lookup client library for JavaScript

[![API Version](https://img.shields.io/badge/api-v2.0.0-blue)](https://developer.factset.com/api-catalog/id-lookup-api)
[![npm](https://img.shields.io/badge/npm-v2.0.2-orange)](https://www.npmjs.com/package/@factset/sdk-idlookup/v/2.0.2)
[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)

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](https://openapi-generator.tech) project:

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

For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)

## Requirements

* Node.js >= 18

## Installation

### npm

```shell
npm install @factset/sdk-utils @factset/sdk-idlookup@2.0.2
```

### yarn

```shell
yarn add @factset/sdk-utils @factset/sdk-idlookup@2.0.2
```

## Usage

1. [Generate authentication credentials](../../../../README.md#authentication).
2. Setup Node.js environment
   1. Install and activate Node.js >=18. If you're using [nvm](https://github.com/nvm-sh/nvm):

      ```sh
      nvm install 18
      nvm use 18
      ```

   2. (optional) [Install yarn](https://yarnpkg.com/getting-started/install).
3. [Install dependencies](#installation).
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


```javascript
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 = equities; // 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:

```javascript
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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*idlookup.FactSetIDLookupApi* | [**helper**](docs/FactSetIDLookupApi.md#helper) | **GET** /metadata/fields/list-by-dataset | Helper endpoint offering a list of supported fields and values to filter a requested dataset.
*idlookup.FactSetIDLookupApi* | [**search**](docs/FactSetIDLookupApi.md#search) | **POST** /lookup | Search functionality to return tickers, company names, and unique identifiers for FactSet data.


## Documentation for Models

 - [idlookup.ErrorExample](docs/ErrorExample.md)
 - [idlookup.ErrorResponse](docs/ErrorResponse.md)
 - [idlookup.FieldsObject](docs/FieldsObject.md)
 - [idlookup.FilterObjects](docs/FilterObjects.md)
 - [idlookup.Filters](docs/Filters.md)
 - [idlookup.HelperEndpoint](docs/HelperEndpoint.md)
 - [idlookup.HelperObject](docs/HelperObject.md)
 - [idlookup.LookupObject](docs/LookupObject.md)
 - [idlookup.LookupRequest](docs/LookupRequest.md)
 - [idlookup.LookupRequestMeta](docs/LookupRequestMeta.md)
 - [idlookup.LookupResponse](docs/LookupResponse.md)
 - [idlookup.LookupResponseMeta](docs/LookupResponseMeta.md)
 - [idlookup.LookupResponseMetaResultCount](docs/LookupResponseMetaResultCount.md)
 - [idlookup.ResponseDetails](docs/ResponseDetails.md)
 - [idlookup.ResponseDetailsUnderlying](docs/ResponseDetailsUnderlying.md)
 - [idlookup.ValuesObject](docs/ValuesObject.md)


## 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](../../../../CONTRIBUTING.md).

# Copyright

Copyright 2026 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.

---
_Source: https://npm.io/package/@factset/sdk-idlookup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._