FactSet Terms and Conditions client library for JavaScript
The FactSet Terms & Conditions API exposes Terms & Conditions data for Fixed Income Corporate, Governement & Agency securities. The FactSet Corporate Government & Agency Terms & Conditions library provides descriptive data on the issue level, such as offering details, redemption information, and coupon schedules. Issuer level data is also available. Coverage is global and includes corporate, sovereign, and agency issues.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit http://www.factset.com/api
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/sdk-factsettermsandconditions@1.0.3
yarn
yarn add @factset/sdk-utils @factset/sdk-factsettermsandconditions@1.0.3
Usage
- Generate authentication credentials.
- Setup Node.js environment
-
Install and activate Node.js >=14. If you're using nvm:
nvm install 16 nvm use 16
-
(optional) Install yarn.
-
- Install dependencies.
- Run the following:
const { ApiClient, AgentsApi } = require('@factset/sdk-factsettermsandconditions');
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 AgentsApi();
const ids = ["30231GBJ","88579EAA"]; // [String] | List of Fixed Income Security identifiers. Supported symbol types include CUSIP, SEDOL, ISIN, and FactSet Security Permanent Identifier (-S). **ID LIMIT = 250** *per request*.
// Call api endpoint
apiInstance.getAgents(ids).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
Class | Method | HTTP request | Description |
---|---|---|---|
factsettermsandconditions.AgentsApi | getAgents | GET /factset-terms-and-conditions/v1/agents | Return Agents items for a Fixed Income security. |
factsettermsandconditions.AgentsApi | getAgentsForList | POST /factset-terms-and-conditions/v1/agents | Return Agents items for a list of Fixed Income securities. |
factsettermsandconditions.ConvertiblesApi | getConvertibleDetails | GET /factset-terms-and-conditions/v1/convertible-details | Return Convertible Details for a list of Convertible Fixed Income securities. |
factsettermsandconditions.ConvertiblesApi | getConvertibleDetailsForList | POST /factset-terms-and-conditions/v1/convertible-details | Return Convertible Details data for a large list of Fixed Income securities. |
factsettermsandconditions.ConvertiblesApi | getConvertibleHistory | GET /factset-terms-and-conditions/v1/convertible-history | Return Convertible History data for a list of Fixed Income securities. |
factsettermsandconditions.ConvertiblesApi | getConvertibleHistoryForList | POST /factset-terms-and-conditions/v1/convertible-history | Return Convertible History data for a large list of Fixed Income securities. |
factsettermsandconditions.ConvertiblesApi | getConvertibleTriggers | GET /factset-terms-and-conditions/v1/convertible-triggers | Return Convertible Triggers data for a list of Fixed Income securities. |
factsettermsandconditions.ConvertiblesApi | getConvertibleTriggersForList | POST /factset-terms-and-conditions/v1/convertible-triggers | Return Convertible Trigger data for a large list of Fixed Income securities. |
factsettermsandconditions.CouponsApi | getCouponHistory | GET /factset-terms-and-conditions/v1/coupon-history | Return historical Coupon information for a Fixed Income security. |
factsettermsandconditions.CouponsApi | getCouponHistoryForList | POST /factset-terms-and-conditions/v1/coupon-history | Return historical Coupon information for a list of Fixed Income securities. |
factsettermsandconditions.CouponsApi | getCouponSchedules | GET /factset-terms-and-conditions/v1/coupon-schedules | Return Coupon Sechedules for a Fixed Income security. |
factsettermsandconditions.CouponsApi | getCouponSchedulesForList | POST /factset-terms-and-conditions/v1/coupon-schedules | Return Coupon Schedules information for a list of Fixed Income securities. |
factsettermsandconditions.CovenantsApi | getCovenantDetails | GET /factset-terms-and-conditions/v1/covenant-details | Return Covenant Details for a Fixed Income security. |
factsettermsandconditions.CovenantsApi | getCovenantDetailsForList | POST /factset-terms-and-conditions/v1/covenant-details | Return Covenant Details for a list of Fixed Income securities. |
factsettermsandconditions.IssueSizeApi | getIssueSize | GET /factset-terms-and-conditions/v1/issue-size | Return Issue Size data for a list of Fixed Income securities. |
factsettermsandconditions.IssueSizeApi | getIssueSizeForList | POST /factset-terms-and-conditions/v1/issue-size | Return Issue Size data for a large list of Fixed Income securities. |
factsettermsandconditions.RedemptionsApi | getFixedIncomeRedemptionPrices | GET /factset-terms-and-conditions/v1/redemption-prices | Return Redemption Prices for a Fixed Income security. |
factsettermsandconditions.RedemptionsApi | getFixedIncomeRedemptionPricesForList | POST /factset-terms-and-conditions/v1/redemption-prices | Return Redemption Prices for a list of Fixed Income securities. |
factsettermsandconditions.TermsConditionsApi | getTermsAndConditions | GET /factset-terms-and-conditions/v1/terms-and-conditions | Return select Terms and Conditions items for a Fixed Income security. |
factsettermsandconditions.TermsConditionsApi | getTermsAndConditionsFields | GET /factset-terms-and-conditions/v1/fields | Available fields for /terms-and-conditions endpoint |
factsettermsandconditions.TermsConditionsApi | getTermsAndConditionsForList | POST /factset-terms-and-conditions/v1/terms-and-conditions | Return Terms and Conditions for a list of Fixed Income securities. |
factsettermsandconditions.UnderwritersApi | getLeadUnderwriters | GET /factset-terms-and-conditions/v1/lead-underwriters | Return Lead Underwriters for a Fixed Income security. |
factsettermsandconditions.UnderwritersApi | getLeadUnderwritersForList | POST /factset-terms-and-conditions/v1/lead-underwriters | Return Lead Underwriters for a list of Fixed Income securities. |
factsettermsandconditions.UseOfProceedsApi | getFixedIncomeUseOfProceeds | GET /factset-terms-and-conditions/v1/use-of-proceeds | Return Use of Proceeds for a Fixed Income security. |
factsettermsandconditions.UseOfProceedsApi | getFixedIncomeUseOfProceedsForList | POST /factset-terms-and-conditions/v1/use-of-proceeds | Return Use of Proceeds for a list of Fixed Income securities. |
Documentation for Models
- factsettermsandconditions.Agent
- factsettermsandconditions.AgentsResponse
- factsettermsandconditions.ConvertibleDetails
- factsettermsandconditions.ConvertibleDetailsResponse
- factsettermsandconditions.ConvertibleHistory
- factsettermsandconditions.ConvertibleHistoryResponse
- factsettermsandconditions.ConvertibleTriggers
- factsettermsandconditions.ConvertibleTriggersResponse
- factsettermsandconditions.CouponHistory
- factsettermsandconditions.CouponHistoryResponse
- factsettermsandconditions.CouponSchedules
- factsettermsandconditions.CouponSchedulesResponse
- factsettermsandconditions.CovenantDetail
- factsettermsandconditions.CovenantDetailsResponse
- factsettermsandconditions.ErrorResponse
- factsettermsandconditions.ErrorResponseSubErrors
- factsettermsandconditions.Field
- factsettermsandconditions.FieldsResponse
- factsettermsandconditions.IssueSize
- factsettermsandconditions.IssueSizeResponse
- factsettermsandconditions.LeadUnderwriter
- factsettermsandconditions.LeadUnderwritersResponse
- factsettermsandconditions.NegativeCovenant
- factsettermsandconditions.NegativeCovenantsResponse
- factsettermsandconditions.RedemptionPrice
- factsettermsandconditions.RedemptionPricesRequest
- factsettermsandconditions.RedemptionPricesResponse
- factsettermsandconditions.TermsAndConditions
- factsettermsandconditions.TermsAndConditionsRequest
- factsettermsandconditions.TermsAndConditionsResponse
- factsettermsandconditions.TermsAndConditionsScalarRequest
- factsettermsandconditions.UseOfProceeds
- factsettermsandconditions.UseOfProceedsResponse
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.