Documents Distributor - Documents client library for JavaScript

Documents APIs that provide filings such as Global Filings and XML files such as StreetAccount

Global Filings API provides the capability to search and download filings documents from various exchanges around the world. This API will provide access to the full history and the ability to search by date and dataset(source). It does not provide real-time updates to the filings documents. Filings providers currently include EDGAR

Note: The real-time updates to the filing documents will be available within week to ten days and per request able to query up to 8 days of data

StreetAccount XML API provides access to historical StreetAccount (SA) news. SA provides a summary for various corporate and market news written by journalist with background in financial markets.

The API delivers SA stories in XML format based on user-specified date input parameters. When the API request is completed, output files will be made available back to the users through a secure URL. This API has three endpoints (1) Request Files (2) Check Status (3) Get Files.

This API only supports adhoc requests to retrieve historical files and does not support real-time files and if require real-time push should consider the other three methods (pushed via SFTP, to QNT account, or users Azure Storage)

Both historical and real-time Street Account news is also delivered via SFTP, to users QNT account, or users Azure Storage.

Files delivered contain both metadata and content body in each file. This eliminates the need to make multiple requests through multiple services to get all the information.

News API provides access to historical news. This provides a summary for various corporate and market news written by journalist with background in financial markets.

The API delivers stories in different format based on user-specified date input parameters. When the API request is completed, output files will be made available back to the users through a secure URL. This API has three endpoints (1) Request Files (2) Check Status (3) Get Files

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

• API version: 1.0.0
• SDK version: 0.22.0
• Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

Requirements

• Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/[email protected]

yarn

yarn add @factset/sdk-utils @factset/[email protected]

Usage

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

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

      nvm install 18
      nvm use 18

   2. (optional) Install yarn.

3. Install dependencies.
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

const { ApiClient, GlobalFilingsAPIApi } = require('@factset/sdk-documentsdistributordocuments');
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 GlobalFilingsAPIApi();
const dataset = "dataset_example"; // String | This parameter filters the results based on the dataset of the filings documents.
const startDate = new Date("2013-10-20"); // Date | The earliest date the API should fetch for. Dates can be YYYY-MM-DD format
const endDate = new Date("2013-10-20"); // Date | The date after upto eight days of the earliest date given the API should fetch for. Dates can be YYYY-MM-DD format

// Call api endpoint
apiInstance.globalFilingsV1ListFilesGet(dataset, startDate, endDate).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-documentsdistributordocuments');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/bulk-documents

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- documentsdistributordocuments.GlobalFilingsAPIApi | globalFilingsV1ListFilesGet | GET /global-filings/v1/list-files | Retrieve filings within FactSet coverage documentsdistributordocuments.NewsAPIApi | asynchNewsV1CheckStatusGet | GET /asynch/news/v1/check-status | Returns the status and percentDone of the requested jobID and source documentsdistributordocuments.NewsAPIApi | asynchNewsV1GetFilesGet | GET /asynch/news/v1/get-files | Returns the news filings for the specified daterange and source documentsdistributordocuments.NewsAPIApi | asynchNewsV1RequestFilesGet | GET /asynch/news/v1/request-files | Returns the jobID documentsdistributordocuments.StreetAccountXMLAPIApi | asynchStreetaccountV1CheckStatusGet | GET /asynch/streetaccount/v1/check-status | Returns the status and percentDone of the requested jobID documentsdistributordocuments.StreetAccountXMLAPIApi | asynchStreetaccountV1GetFilesGet | GET /asynch/streetaccount/v1/get-files | Returns the SA XML files for the specified daterange documentsdistributordocuments.StreetAccountXMLAPIApi | asynchStreetaccountV1RequestFilesGet | GET /asynch/streetaccount/v1/request-files | Returns the jobID

Documentation for Models

• documentsdistributordocuments.Checkstatus
• documentsdistributordocuments.CheckstatusResponse
• documentsdistributordocuments.Checkstatusone
• documentsdistributordocuments.FilingsFiles
• documentsdistributordocuments.Getfiles
• documentsdistributordocuments.GetfilesResponse
• documentsdistributordocuments.Getfilesone
• documentsdistributordocuments.IsPartialOne
• documentsdistributordocuments.MetaOne
• documentsdistributordocuments.NewsStatus
• documentsdistributordocuments.NewscheckstatusResponse
• documentsdistributordocuments.NewsgetfilesResponse
• documentsdistributordocuments.NewsrequestfilesResponse
• documentsdistributordocuments.PaginationOne
• documentsdistributordocuments.RequestfilesResponse
• documentsdistributordocuments.Status
• documentsdistributordocuments.StreetAccountStatus

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.