Global Filings client library for JavaScript
npm install @factset/sdk-globalfilings
The Filings API provides a comprehensive set of functionalities for searching and retrieving filing documents from various sources.
This API is designed to expose document search and document retrieval functionality. A document search will allow a request to query FactSet document databases based on certain search criteria specified in the request.
In addition, a document count request will provide information on the number of stories available for a particular security.
The meta endpoints, such as sources, formTypes, timeZones, and categories, provide comprehensive lists of available sources, form types, time zones, and categories, respectively.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 2.2.0
- SDK version: 3.3.0
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen
For more information, please visit https://developer.factset.com/contact
* Node.js >= 18
``shell`
npm install @factset/sdk-utils @factset/sdk-globalfilings@3.3.0
`shell`
yarn add @factset/sdk-utils @factset/sdk-globalfilings@3.3.0
1. Generate authentication credentials.
2. Setup Node.js environment
1. Install and activate Node.js >=18. If you're using nvm:
`sh`
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.
`javascript
const { ApiClient, FilingsAPIApi } = require('@factset/sdk-globalfilings');
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 FilingsAPIApi();
const ids = ["MODN-US"]; // [String] | Requested symbols or securities. This is a comma-separated list with a maximum limit of 1000. Each symbol can be a FactSet exchange symbol, CUSIP, SEDOL, ISIN, or Entity ID
const sources = ["EDG"]; // [String] | Code for document source to include.This is a comma-separated list. Use the /meta/sources endpoint to get the list of available sources. /meta/categories
const opts = {
'startDate': 20240601, // String | Start Date. Format is YYYYMMDD or relative +/- days (0,-1,etc).
'endDate': 20241101, // String | End Date. Format is YYYYMMDD or relative +/- days (0,-1,etc).
'timeZone': "'America/New_York'", // String | timeZone to return story dates and times.Time zones, represented in POSIX format, are automatically adjusted for daylight savings. timeZone names are sourced from the IANA timezone registry.
'categories': ["CN:US"], // [String] | Code for categories to include. This is a comma-separated list. Use the endpoint to get the list of available categories. Default = All categories.
'primaryId': false, // Boolean | Type of identifier search true - Returns headlines of stories that have the searched identifier(s) as the primary identifier. false - Returns headlines of stories that mentioned or referred to the identifier.
'searchText': Officer, // String | Restricts the search to include only document stories that include the searched text. This parameter supports boolean operators as well.
'formTypes': ["15-12G"] // [String] | The search to include any form types of given sources
};
// Call api endpoint
apiInstance.getCount(ids, sources, opts).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
`
To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:
`javascript
const { ApiClient } = require('@factset/sdk-globalfilings');
const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:password@proxy.example.com:8080');
``
All URIs are relative to https://api.factset.com/content/global-filings/v2
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
globalfilings.FilingsAPIApi | getCount | GET /count | Returns the count of filings for specified source.
globalfilings.FilingsAPIApi | getFilings | GET /search | Returns the filings documents and related metadata within FactSet coverage.
globalfilings.MetaApi | getFormtype | GET /meta/form-types | Returns the form types of specified sources.
globalfilings.MetaApi | getSources | GET /meta/sources | Returns the sources.
globalfilings.MetaApi | getTimezone | GET /meta/time-zones | Returns the time zones.
globalfilings.MetaApi | getcategories | GET /meta/categories | Returns the categories.
- globalfilings.Category
- globalfilings.CategoryResponse
- globalfilings.Count
- globalfilings.CountResponse
- globalfilings.Document
- globalfilings.ErrorObject
- globalfilings.ErrorResponse
- globalfilings.FormType
- globalfilings.FormTypeResponse
- globalfilings.InvalidIdErrorObject
- globalfilings.SearchResponse
- globalfilings.SearchResponseMeta
- globalfilings.SearchResponseMetaPagination
- globalfilings.SearchResult
- globalfilings.Source
- globalfilings.SourceResponse
- globalfilings.TimeZone
- globalfilings.TimeZoneResponse
- Type: HTTP basic authentication
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Please refer to the contributing guide.
Copyright 2025 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.