npm i @factset/sdk-ofdb


The FactSet Enterprise SDK facilitates access to APIs

by factset

0.21.2 (see all)License:Apache License, Version 2.0TypeScript:Not Found
npm i @factset/sdk-ofdb


OFDB client library for JavaScript

npm Apache-2 license

OFDB api

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

  • API version: 1.0.0
  • Package version: 0.21.2
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen


  • Node.js >= 14



npm install @factset/sdk-utils @factset/sdk-ofdb


yarn add @factset/sdk-utils @factset/sdk-ofdb


  1. Generate authentication credentials.

  2. Setup Node.js environment

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

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

  3. Install dependencies.

  4. Run the following:

const { ApiClient, CreateApi } = require('@factset/sdk-ofdb');
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
// 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 CreateApi();
const path = "path_example"; // String | Encode database path
const addSymbolDate = new ofdb.AddSymbolDate(); // AddSymbolDate | Required data for creating date in the database. At least one iterative field is required otherwise it will throw 400.

// Call api endpoint
apiInstance.addSymbolDate(path, addSymbolDate).then(
  data => {

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

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/analytics/ofdb

ClassMethodHTTP requestDescription
ofdb.CreateApiaddSymbolDatePOST /v1/database/{path}/dates
ofdb.CreateApiaddSymbolDate3DPOST /v1/database/{path}/dates/{date}/symbols
ofdb.CreateApiaddSymbolsPOST /v1/database/{path}/symbols
ofdb.CreateApicreateDatabasePOST /v1/database/
ofdb.ModifyApideleteDatesDELETE /v1/database/{path}/dates/{date}
ofdb.ModifyApideleteSymbolDate3DDELETE /v1/database/{path}/dates/{date}/symbols/{symbol}
ofdb.ModifyApideleteSymbolsDELETE /v1/database/{path}/symbols/{symbol}
ofdb.ModifyApiupdateSymbolDatePUT /v1/database/{path}/dates/{date}
ofdb.ModifyApiupdateSymbolDate3DPUT /v1/database/{path}/dates/{date}/symbols/{symbol}
ofdb.ModifyApiupdateSymbolsPUT /v1/database/{path}/symbols/{symbol}
ofdb.ViewApigetDatabaseGET /v1/database/{path}
ofdb.ViewApigetDatesGET /v1/database/{path}/dates
ofdb.ViewApigetFieldsGET /v1/database/{path}/fields
ofdb.ViewApigetSymbolsGET /v1/database/{path}/symbols

Documentation for Models

Documentation for Authorization


  • Type: HTTP basic authentication


  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A


Please refer to the contributing guide.


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


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.

No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

No reviews found
Be the first to rate