@factset/sdk-factsetmergersandacquisitions

1.0.1 • Public • Published

FactSet

FactSet Mergers and Acquisitions client library for JavaScript

API Version npm Apache-2 license

The FactSet Mergers and Acquisitions API provides access to key transactions and pricing metrics on over 60,000 globally traded deals. Reference a Global Universe of Mergers and Acquisitions (M&A) transactions where the target of the deal is a Publicly traded Company. Review premiums, multiples and fundamental data to gather insights on deals and create predictive models based on different deal characteristics.

Monetary values returned by this API are converted and represented in USD.

This API is allows a limit of 10 requests per second and a maximum of 10 concurrent requests.

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

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

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

Requirements

  • Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-factsetmergersandacquisitions@1.0.1

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetmergersandacquisitions@1.0.1

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:

[!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, DealsApi } = require('@factset/sdk-factsetmergersandacquisitions');
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 DealsApi();
const dealsRequest = new factsetmergersandacquisitions.DealsRequest(); // DealsRequest | Request object for `Deals`.

// Call api endpoint
apiInstance.getDealsByCompanyList(dealsRequest).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/content/factset-mergers-acquisitions/v1

Class Method HTTP request Description
factsetmergersandacquisitions.DealsApi getDealsByCompanyList POST /deals/by-company Returns details for a list of companies.
factsetmergersandacquisitions.DealsApi getDealsDetailsList POST /deals/details Returns details for specified deals.
factsetmergersandacquisitions.DealsApi getPublicTargetDealsList POST /deals/public-targets Returns a list of deals in which the target is a public company.

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-factsetmergersandacquisitions

Weekly Downloads

0

Version

1.0.1

License

Apache-2.0

Unpacked Size

145 kB

Total Files

28

Last publish

Collaborators

  • enterprisesdk
  • fds
  • tsouthmaydfds