@factset/sdk-factsetprivatemarkets
v2.0.0
Published
FactSet Private Markets client library for JavaScript
Downloads
11
Readme
FactSet Private Markets client library for JavaScript
FactSet Private Markets API encompasses Private Company Financials data to start. Private Company firmographics can be found in the FactSet Entity API. The future plans of this service will include additional Private Markets data, such as Private Equity/Venture Capital.Rate limit is set to 10 requests per second.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.2.0
- SDK version: 2.0.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
- Generate authentication credentials.
- Setup Node.js environment
Install and activate Node.js >=18. If you're using nvm:
nvm install 18 nvm use 18
(optional) Install yarn.
- Install dependencies.
- 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, DataItemsApi } = require('@factset/sdk-factsetprivatemarkets');
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 DataItemsApi();
const opts = {
'category': FINANCIALS // String | Filters the list of available fields per endpoint - * **FINANCIALS** = Financials endpoint data items, such as Assets, Liabilities, and EBITDA. * **NON_PERIODIC** = Non-Periodic endpoint data items, such as ISO Currency, Current CEO, and Investor List.
};
// Call api endpoint
apiInstance.getFields(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-factsetprivatemarkets');
const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/content
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- factsetprivatemarkets.DataItemsApi | getFields | GET /factset-private-markets/v1/fields | Available private company fields, metrics, and ratios. factsetprivatemarkets.FinancialsApi | getFinancials | GET /factset-private-markets/v1/financials | Returns Private Company Financials for a list of ids. factsetprivatemarkets.FinancialsApi | getFinancialsForList | POST /factset-private-markets/v1/financials | Returns Private Company Financials for a list of ids. factsetprivatemarkets.NonPeriodicApi | getNonPeriodic | GET /factset-private-markets/v1/non-periodic | Returns Private Company reference data for a list of ids. factsetprivatemarkets.NonPeriodicApi | getNonPeriodicForList | POST /factset-private-markets/v1/non-periodic | Returns Private Company reference data for a list of ids. factsetprivatemarkets.UniverseApi | getUniverse | GET /factset-private-markets/v1/universe | Get Entity Candidates and Matches for a single name and attributes. factsetprivatemarkets.UniverseApi | getUniverseForList | POST /factset-private-markets/v1/universe | Get a list of Entity Candidates and Matches for a requested list of up to 25 names and attributes.
Documentation for Models
- factsetprivatemarkets.EntityMatch
- factsetprivatemarkets.EntityMatchRequest
- factsetprivatemarkets.EntityMatchRequestInput
- factsetprivatemarkets.EntityMatchesResponse
- factsetprivatemarkets.ErrorResponse
- factsetprivatemarkets.ErrorResponseSubErrors
- factsetprivatemarkets.Field
- factsetprivatemarkets.FieldsResponse
- factsetprivatemarkets.Financials
- factsetprivatemarkets.FinancialsRequest
- factsetprivatemarkets.FinancialsResponse
- factsetprivatemarkets.NonPeriodic
- factsetprivatemarkets.NonPeriodicRequest
- factsetprivatemarkets.NonPeriodicResponse
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.