@factset/sdk-ofdb

0.30.5 • Public • Published

FactSet

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: 2.1.0
  • Package version: 0.30.5
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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

Requirements

  • Node.js >= 14

Installation

npm

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

yarn

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

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, AddApi } = 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 AddApi();
const path = "path_example"; // String | Encode database path
const addDates = {"data":[{"date":20220107,"content":[{"symbol":"FDS","price":444}]}]}; // AddDates | Required data for creating date in the database. At least one iterative field is required otherwise it will throw 400.

// Call api endpoint
apiInstance.addDates(path, addDates).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/v2

Class Method HTTP request Description
ofdb.AddApi addDates POST /database/{path}/dates
ofdb.AddApi addFields POST /database/{path}/fields
ofdb.AddApi addSymbols POST /database/{path}/symbols
ofdb.CreateApi createDatabase POST /database
ofdb.DeleteApi deleteBulkItems POST /database/{path}/delete
ofdb.DeleteApi deleteDate DELETE /database/{path}/dates/{date}
ofdb.DeleteApi deleteDateFromSymbol DELETE /database/{path}/dates/{date}/symbols/{symbol}
ofdb.DeleteApi deleteSymbol DELETE /database/{path}/symbols/{symbol}
ofdb.DeleteApi getResourceDateFromSymbol DELETE /database/{path}/dates/{date}/symbols/{symbol}/jobs/{id}
ofdb.GetApi getAudit GET /database/{path}/audit
ofdb.GetApi getData GET /database/{path}
ofdb.GetApi getDates GET /database/{path}/dates
ofdb.GetApi getFields GET /database/{path}/fields
ofdb.GetApi getStats GET /database/{path}/stats
ofdb.GetApi getSymbols GET /database/{path}/symbols
ofdb.LongRunningApi getResourceAudit GET /database/{path}/audit/jobs/{id}
ofdb.LongRunningApi getResourceBulkDelete GET /database/{path}/delete/jobs/{id}
ofdb.LongRunningApi getResourceData GET /database/{path}/jobs/{id}
ofdb.LongRunningApi getResourceDatabase GET /database/jobs/{id}
ofdb.LongRunningApi getResourceDate GET /database/{path}/dates/{date}/jobs/{id}
ofdb.LongRunningApi getResourceDates GET /database/{path}/dates/jobs/{id}
ofdb.LongRunningApi getResourceFields GET /database/{path}/fields/jobs/{id}
ofdb.LongRunningApi getResourceStats GET /database/{path}/stats/jobs/{id}
ofdb.LongRunningApi getResourceSymbol GET /database/{path}/symbols/{symbol}/jobs/{id}
ofdb.LongRunningApi getResourceSymbols GET /database/{path}/symbols/jobs/{id}
ofdb.LongRunningApi getStatus GET /database/jobs/{id}/status
ofdb.UpdateApi updateDate PUT /database/{path}/dates/{date}
ofdb.UpdateApi updateDates PUT /database/{path}/dates
ofdb.UpdateApi updateSymbol PUT /database/{path}/symbols/{symbol}
ofdb.UpdateApi updateSymbols PUT /database/{path}/symbols

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.

Readme

Keywords

Package Sidebar

Install

npm i @factset/sdk-ofdb

Weekly Downloads

2

Version

0.30.5

License

Apache-2.0

Unpacked Size

259 kB

Total Files

68

Last publish

Collaborators

  • enterprisesdk
  • fds
  • tsouthmaydfds