@factset/sdk-etfprofileandprices NPM

ETF Profile and Prices client library for JavaScript

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

API version: v1
Package version: 0.10.5
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Requirements

Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-etfprofileandprices@0.10.5

yarn

yarn add @factset/sdk-utils @factset/sdk-etfprofileandprices@0.10.5

Usage

Generate authentication credentials.
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.
Install dependencies.
Run the following:

const { ApiClient, FactsetApi } = require('@factset/sdk-etfprofileandprices');
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 FactsetApi();
const symbol = "symbol_example"; // String | Market symbol of ETP defined by FactSet.
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'paginationOffset': 0.0, // Number | Non-negative number of entries to skip, or 0 (default).
  'paginationLimit': 20.0 // Number | Non-negative maximum number of entries to return.
};

// Call api endpoint
apiInstance.getFactsetEtfAllocationAssetListBySymbol(symbol, opts).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/wealth/v1

Class	Method	HTTP request	Description
etfprofileandprices.FactsetApi	getFactsetEtfAllocationAssetListBySymbol	GET /factset/etf/allocation/asset/listBySymbol	This endpoint returns selected ETP's asset allocations.
etfprofileandprices.FactsetApi	getFactsetEtfAllocationCountryListBySymbol	GET /factset/etf/allocation/country/listBySymbol	This endpoint returns selected ETP's country allocations.
etfprofileandprices.FactsetApi	getFactsetEtfAllocationCurrencyListBySymbol	GET /factset/etf/allocation/currency/listBySymbol	This endpoint returns selected ETP's currency allocations.
etfprofileandprices.FactsetApi	getFactsetEtfAllocationEconomicDevelopmentListBySymbol	GET /factset/etf/allocation/economicDevelopment/listBySymbol	List of allocations classified by a holding's economic development status.
etfprofileandprices.FactsetApi	getFactsetEtfAllocationExchangeListBySymbol	GET /factset/etf/allocation/exchange/listBySymbol	This endpoint returns selected ETP's exchange allocations.
etfprofileandprices.FactsetApi	getFactsetEtfAllocationIndustryListBySymbol	GET /factset/etf/allocation/industry/listBySymbol	This endpoint returns selected ETP's industry allocations.
etfprofileandprices.FactsetApi	getFactsetEtfAllocationMarketCapitalizationListBySymbol	GET /factset/etf/allocation/marketCapitalization/listBySymbol	List of allocations classified by a holding's total market capitalization.
etfprofileandprices.FactsetApi	getFactsetEtfAllocationRegionListBySymbol	GET /factset/etf/allocation/region/listBySymbol	This endpoint returns selected ETP's region allocations.
etfprofileandprices.FactsetApi	getFactsetEtfAllocationSectorListBySymbol	GET /factset/etf/allocation/sector/listBySymbol	This endpoint returns selected ETP's sector allocations.
etfprofileandprices.FactsetApi	getFactsetEtfAnalyticsGetBySymbol	GET /factset/etf/analytics/getBySymbol	FactSet proprietary analytics datapoints for ETPs.
etfprofileandprices.FactsetApi	getFactsetEtfAnalyticsHoldingsStatisticsGetBySymbol	GET /factset/etf/analytics/holdings/statistics/getBySymbol	FactSet's portfolio statistics for ETPs.
etfprofileandprices.FactsetApi	getFactsetEtfAnalyticsScoreGetBySymbol	GET /factset/etf/analytics/score/getBySymbol	FactSet proprietary ETP rankings.
etfprofileandprices.FactsetApi	getFactsetEtfAnalyticsTradeGetBySymbol	GET /factset/etf/analytics/trade/getBySymbol	Trade statistics for specific ETP.
etfprofileandprices.FactsetApi	getFactsetEtfCharacteristicsGetBySymbol	GET /factset/etf/characteristics/getBySymbol	Retrieve basic characteristic information for a specified ETP.
etfprofileandprices.FactsetApi	getFactsetEtfClassCategoryBroadList	GET /factset/etf/class/category/broad/list	List of ETP class broad categories.
etfprofileandprices.FactsetApi	getFactsetEtfClassCategoryFocusList	GET /factset/etf/class/category/focus/list	List of ETP class focus categories.
etfprofileandprices.FactsetApi	getFactsetEtfClassCategoryNicheList	GET /factset/etf/class/category/niche/list	List of ETP class niche categories.
etfprofileandprices.FactsetApi	getFactsetEtfClassGeographyList	GET /factset/etf/class/geography/list	List of ETP class geographies.
etfprofileandprices.FactsetApi	getFactsetEtfClassGetBySymbol	GET /factset/etf/class/getBySymbol	Retrieve an ETP's classification specific to asset class, geography, or investment strategy.
etfprofileandprices.FactsetApi	getFactsetEtfCompetitorsListBySymbol	GET /factset/etf/competitors/listBySymbol	FactSet's proprietary list of competing companies.
etfprofileandprices.FactsetApi	getFactsetEtfDistributionGetBySymbol	GET /factset/etf/distribution/getBySymbol	Retrieve an ETP's current distribution details.
etfprofileandprices.FactsetApi	getFactsetEtfFundFlowsGetBySymbol	GET /factset/etf/fundFlows/getBySymbol	Retrieve an ETP's cash inflow/outflows for various time periods.
etfprofileandprices.FactsetApi	getFactsetEtfGetBySymbol	GET /factset/etf/getBySymbol	Retrieve basic profile information for a specified ETP.
etfprofileandprices.FactsetApi	getFactsetEtfGrowthOfTenKListBySymbol	GET /factset/etf/growthOfTenK/listBySymbol	This endpoint returns selected ETP's Growth of 10K calculated values.
etfprofileandprices.FactsetApi	getFactsetEtfHoldingsListBySymbol	GET /factset/etf/holdings/listBySymbol	Holdings details for an individual ETP.
etfprofileandprices.FactsetApi	getFactsetEtfMarketAggregatesGetBySymbol	GET /factset/etf/marketAggregates/getBySymbol	Market aggregate data for ETPs.
etfprofileandprices.FactsetApi	getFactsetEtfPremiumDiscountSummaryListBySymbol	GET /factset/etf/premiumDiscount/summary/listBySymbol	Summary of ETP premium discount data.
etfprofileandprices.FactsetApi	getFactsetEtfPriceGetBySymbol	GET /factset/etf/price/getBySymbol	Retrieve historical ETP NAV values.
etfprofileandprices.FactsetApi	getFactsetEtfReturnsGetBySymbol	GET /factset/etf/returns/getBySymbol	Retrieve total return data for a specified ETP.
etfprofileandprices.FactsetApi	getFactsetEtfStrategyGetBySymbol	GET /factset/etf/strategy/getBySymbol	Retrieve various classification details for a specified ETP.
etfprofileandprices.FactsetApi	getFactsetEtfStrategySegmentList	GET /factset/etf/strategy/segment/list	Retrieve a list of ETP strategy segments.
etfprofileandprices.FactsetApi	getFactsetEtfStructureGetBySymbol	GET /factset/etf/structure/getBySymbol	Retrieve the basic structure information for a specified ETP.
etfprofileandprices.FactsetApi	getFactsetEtfTaxesAndFeesUsGetBySymbol	GET /factset/etf/taxesAndFees/us/getBySymbol	Retrieve the tax and fee related information for a specified ETP.
etfprofileandprices.FactsetApi	getFactsetEtfTimeSeriesListBySymbol	GET /factset/etf/timeSeries/listBySymbol	Retrieve historical NAV data for a specified ETP.

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

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.

FactSet API SDK

@factset/sdk-utils superagent

@everything-registry/sub-chunk-312

8 months ago

7 months ago

11 months ago

2 years ago