npm.io
0.2.0 • Published 1 week ago

@factset/sdk-ofdb

Licence
Apache-2.0
Version
0.2.0
Deps
3
Size
200 kB
Vulns
0
Weekly
0
Stars
56
SummaryDependencyVersions

FactSet

OFDB client library for JavaScript

API Version npm Apache-2 license

OFDB API

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

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

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

Requirements

  • Node.js >= 22

Installation

npm
npm install @factset/sdk-utils @factset/sdk-ofdb@0.2.0
yarn
yarn add @factset/sdk-utils @factset/sdk-ofdb@0.2.0

Usage

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

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

      nvm install 22
nvm use 22

    2. (optional) Install yarn.

  3. Install dependencies.
  4. Run the following:

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, AuditApi } = 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
//
// 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 AuditApi();
const opts = {
  'databasePathRoot': {"data":{"databasePath":"Client:/Folder1/Database.OFDB"}} // DatabasePathRoot | The databasePath to be fetched
};

// Call api endpoint
apiInstance.getAudit(opts).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-ofdb');

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/analytics/ofdb/v3

Class Method HTTP request Description
ofdb.AuditApi getAudit POST /database/audit/get
ofdb.AuditApi getResourceGetAudit GET /database/job/result/audit/get
ofdb.BulkDeleteApi deleteBulkItems POST /database/bulk-delete
ofdb.BulkDeleteApi getResourceDeleteBulkItems GET /database/job/result/bulk-delete/get
ofdb.DataApi getData POST /database/data/get
ofdb.DataApi getResourceGetData GET /database/job/result/data/get
ofdb.DatesApi getDates POST /database/dates/get
ofdb.DatesApi getResourceGetDates GET /database/job/result/dates/get
ofdb.DatesApi replaceDates POST /database/dates/replace
ofdb.DatesApi updateDates POST /database/dates/update
ofdb.JobStatusApi getDatabaseStatusById GET /database/job/status/get
ofdb.SchemaApi addFields POST /database/schema/add
ofdb.SchemaApi createDatabase POST /database/schema/create
ofdb.SchemaApi getFields POST /database/schema/get
ofdb.SchemaApi getResourceGetFields GET /database/job/result/schema/get
ofdb.StatsApi getResourceGetStats GET /database/job/result/stats/get
ofdb.StatsApi getStats POST /database/stats/get
ofdb.SymbolsApi getResourceGetSymbols GET /database/job/result/symbols/get
ofdb.SymbolsApi getSymbols POST /database/symbols/get
ofdb.SymbolsApi replaceSymbols POST /database/symbols/replace
ofdb.SymbolsApi updateSymbols POST /database/symbols/update

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

Keywords

FactSetAPISDK