@factset/sdk-factsetprivateequityandventurecapital
v1.0.0
Published
FactSet Private Equity and Venture Capital client library for JavaScript
Readme
FactSet Private Equity and Venture Capital client library for JavaScript
Comprehensive API for accessing private equity and venture capital data including funds, general partners, transactions, and portfolio companies.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- SDK version: 1.0.0
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen
For more information, please visit https://developer.factset.com/contact
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, FundsApi } = require('@factset/sdk-factsetprivateequityandventurecapital');
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 FundsApi();
const ids = ["001JYM-E","005GEM-E"]; // [String] | A list of FactSet Permanent Entity Identifiers (FactSet IDs) for **Private Equity and Venture Capital Funds**. These IDs are in the format 'XXXXXX-E' and are the primary input for most fund-related endpoints. These IDs can be retrieved from the /universe endpoint
// Call api endpoint
apiInstance.getFund(ids).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-factsetprivateequityandventurecapital');
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/factset-pevc/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- factsetprivateequityandventurecapital.FundsApi | getFund | GET /funds | Retrieve core profile and summary data for specified Private Equity or Venture Capital Funds. factsetprivateequityandventurecapital.FundsApi | getFundCashflows | POST /funds/cashflows | Retrieve time-series cash flow data (contributions and distributions) for specified funds. factsetprivateequityandventurecapital.FundsApi | getFundFundraising | GET /funds/fundraising | Retrieve the complete fundraising history for specified Private Equity or Venture Capital Funds. factsetprivateequityandventurecapital.FundsApi | getFundPortfolioCompanies | GET /funds/portfolio-companies | Retrieve the list of portfolio companies held by specified Private Equity or Venture Capital Funds. factsetprivateequityandventurecapital.GeneralAndLimitedPartnersApi | getFundLimitedPartners | GET /limited-partners/funds | Retrieve the Limited Partners (LPs) and their capital commitments to specific funds. factsetprivateequityandventurecapital.GeneralAndLimitedPartnersApi | getGP | GET /general-partners | Retrieve core profile and summary data for specified General Partner (GP) firms. factsetprivateequityandventurecapital.GeneralAndLimitedPartnersApi | getGPFunds | GET /general-partners/funds | Retrieve the list of all Private Equity and Venture Capital Funds managed by specified General Partners. factsetprivateequityandventurecapital.IPOsApi | getIPO | GET /ipos | Retrieve details of an Initial Public Offering (IPO) related to a portfolio company exit. factsetprivateequityandventurecapital.IPOsApi | searchIPOs | POST /ipos/search | Search and filter the universe of portfolio company IPOs by status, size, and date range. factsetprivateequityandventurecapital.StrategiesApi | getEntityStrategies | GET /entities/strategies | Retrieve detailed investment strategy mandates for a specified fund or General Partner. factsetprivateequityandventurecapital.TransactionsApi | getTransaction | GET /transactions | Retrieve comprehensive details for a list of Private Equity or Venture Capital transactions. factsetprivateequityandventurecapital.TransactionsApi | getTransactionMAActivity | GET /transactions/ma-activity | Retrieve detailed M&A advisory and investment information for specified transactions. factsetprivateequityandventurecapital.TransactionsApi | searchTransactions | POST /transactions/search | Search and filter the universe of transactions by deal size, date range, stage, and portfolio company. factsetprivateequityandventurecapital.UniverseApi | getUniverse | GET /universe | Returns Entity Candidates and Matches for a single name and attributes.
Documentation for Models
- factsetprivateequityandventurecapital.AUMItem
- factsetprivateequityandventurecapital.ControlItem
- factsetprivateequityandventurecapital.CountryItem
- factsetprivateequityandventurecapital.EntityMatch
- factsetprivateequityandventurecapital.EntityMatchesResponse
- factsetprivateequityandventurecapital.EntityStrategiesResponse
- factsetprivateequityandventurecapital.EntityStrategy
- factsetprivateequityandventurecapital.EntityStrategyGeographicFocus
- factsetprivateequityandventurecapital.EntityStrategySectorFocus
- factsetprivateequityandventurecapital.ErrorObject
- factsetprivateequityandventurecapital.ErrorObjectLinks
- factsetprivateequityandventurecapital.ErrorObjectResponse
- factsetprivateequityandventurecapital.ErrorResponse
- factsetprivateequityandventurecapital.Fund
- factsetprivateequityandventurecapital.FundCashflow
- factsetprivateequityandventurecapital.FundCashflowsRequest
- factsetprivateequityandventurecapital.FundCashflowsRequestData
- factsetprivateequityandventurecapital.FundCashflowsResponse
- factsetprivateequityandventurecapital.FundDetail
- factsetprivateequityandventurecapital.FundDetailDates
- factsetprivateequityandventurecapital.FundDetailFeatures
- factsetprivateequityandventurecapital.FundDetailFinancialInfo
- factsetprivateequityandventurecapital.FundDetailFundOfFundAllocation
- factsetprivateequityandventurecapital.FundDetailInvestmentCriteria
- factsetprivateequityandventurecapital.FundDetailTerms
- factsetprivateequityandventurecapital.FundDetailsResponse
- factsetprivateequityandventurecapital.FundFundraising
- factsetprivateequityandventurecapital.FundFundraisingResponse
- factsetprivateequityandventurecapital.FundLimitedPartners
- factsetprivateequityandventurecapital.FundLimitedPartnersResponse
- factsetprivateequityandventurecapital.FundPortfolioCompaniesResponse
- factsetprivateequityandventurecapital.FundPortfolioCompany
- factsetprivateequityandventurecapital.FundSummary
- factsetprivateequityandventurecapital.FundraisingRound
- factsetprivateequityandventurecapital.GPDetail
- factsetprivateequityandventurecapital.GPDetailFeatures
- factsetprivateequityandventurecapital.GPDetailInvestmentCriteria
- factsetprivateequityandventurecapital.GPDetailsResponse
- factsetprivateequityandventurecapital.GPFund
- factsetprivateequityandventurecapital.GPFundsResponse
- factsetprivateequityandventurecapital.IPODetail
- factsetprivateequityandventurecapital.IPODetailsResponse
- factsetprivateequityandventurecapital.IPOSearchRequest
- factsetprivateequityandventurecapital.IPOSearchRequestData
- factsetprivateequityandventurecapital.IPOSearchResponse
- factsetprivateequityandventurecapital.IPOSummary
- factsetprivateequityandventurecapital.IndustryItem
- factsetprivateequityandventurecapital.InstrumentItem
- factsetprivateequityandventurecapital.LimitedPartner
- factsetprivateequityandventurecapital.MaAdvisor
- factsetprivateequityandventurecapital.MaInvestment
- factsetprivateequityandventurecapital.PortfolioCompany
- factsetprivateequityandventurecapital.RegionItem
- factsetprivateequityandventurecapital.RoleItem
- factsetprivateequityandventurecapital.SectorItem
- factsetprivateequityandventurecapital.StateProvinceItem
- factsetprivateequityandventurecapital.StrategyCodeItem
- factsetprivateequityandventurecapital.TransactionDetail
- factsetprivateequityandventurecapital.TransactionDetailDetails
- factsetprivateequityandventurecapital.TransactionDetailFinancial
- factsetprivateequityandventurecapital.TransactionDetailsResponse
- factsetprivateequityandventurecapital.TransactionInvestor
- factsetprivateequityandventurecapital.TransactionMaActivity
- factsetprivateequityandventurecapital.TransactionMaActivityResponse
- factsetprivateequityandventurecapital.TransactionSearchRequest
- factsetprivateequityandventurecapital.TransactionSearchRequestData
- factsetprivateequityandventurecapital.TransactionSearchResponse
- factsetprivateequityandventurecapital.TransactionSecurity
- factsetprivateequityandventurecapital.TransactionSummary
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 2026 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.0Unless 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.
