OFDB client library for JavaScript

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

Requirements

• Node.js >= 14

Installation

npm

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

yarn

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

Usage

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:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ofdb.CreateApi	addSymbolDate	POST /v1/database/{path}/dates
ofdb.CreateApi	addSymbolDate3D	POST /v1/database/{path}/dates/{date}/symbols
ofdb.CreateApi	addSymbols	POST /v1/database/{path}/symbols
ofdb.CreateApi	createDatabase	POST /v1/database/
ofdb.ModifyApi	deleteDates	DELETE /v1/database/{path}/dates/{date}
ofdb.ModifyApi	deleteSymbolDate3D	DELETE /v1/database/{path}/dates/{date}/symbols/{symbol}
ofdb.ModifyApi	deleteSymbols	DELETE /v1/database/{path}/symbols/{symbol}
ofdb.ModifyApi	updateSymbolDate	PUT /v1/database/{path}/dates/{date}
ofdb.ModifyApi	updateSymbolDate3D	PUT /v1/database/{path}/dates/{date}/symbols/{symbol}
ofdb.ModifyApi	updateSymbols	PUT /v1/database/{path}/symbols/{symbol}
ofdb.ViewApi	getDatabase	GET /v1/database/{path}
ofdb.ViewApi	getDates	GET /v1/database/{path}/dates
ofdb.ViewApi	getFields	GET /v1/database/{path}/fields
ofdb.ViewApi	getSymbols	GET /v1/database/{path}/symbols

Documentation for Models

• ofdb.AddDatabase
• ofdb.AddSymbolDate
• ofdb.AddSymbolDate3D
• ofdb.AddSymbolDate3DData
• ofdb.AddSymbolDateData
• ofdb.AddSymbols
• ofdb.AddSymbolsData
• ofdb.DatabaseSchema
• ofdb.InlineResponse202
• ofdb.InlineResponse400
• ofdb.InlineResponse400Errors
• ofdb.InlineResponse400Source
• ofdb.InlineResponse403
• ofdb.InlineResponse403Errors
• ofdb.InlineResponse404
• ofdb.InlineResponse404Errors
• ofdb.InlineResponse413
• ofdb.InlineResponse413Errors
• ofdb.InlineResponse429
• ofdb.InlineResponse429Errors
• ofdb.SuccessPostResponse
• ofdb.UpdateSymbolDate
• ofdb.UpdateSymbolDate3D
• ofdb.UpdateSymbolDate3DData
• ofdb.UpdateSymbols
• ofdb.UpdateSymbolsData

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.