client-twelve-data-rapidapi
Version:
Complete TypeScript library for Twelve Data API with 154 endpoints, technical indicators, and intelligent rate limiting
83 lines (82 loc) • 4.43 kB
TypeScript
import type { HttpClient } from '../utils/http-client.js';
import type { MutualFundsListParams, MutualFundsTypeListParams, MutualFundsFamilyListParams, MutualFundsMarketMoversParams, MutualFundsAllDataParams, MutualFundsSummaryParams, MutualFundsPerformanceParams, MutualFundsRiskParams, MutualFundsRatingsParams, MutualFundsCompositionParams, MutualFundsPurchaseInfoParams, MutualFundsSustainabilityParams, ApiResponse, MutualFundData, MutualFundTypeData, MutualFundFamilyData, MutualFundMarketMoverData, MutualFundAllData, MutualFundSummaryData, MutualFundPerformanceData, MutualFundRiskData, MutualFundRatingsData, MutualFundCompositionData, MutualFundPurchaseInfoData, MutualFundSustainabilityData } from '../types/index.js';
/**
* Mutual Funds endpoints for Twelve Data API
* Provides access to mutual fund data, performance, risk metrics, and more
*/
export declare class MutualFundsEndpoints {
private httpClient;
constructor(httpClient: HttpClient);
/**
* Get list of available mutual funds
* @param params - Parameters for filtering mutual funds
* @returns Promise with list of mutual funds
*/
getMutualFundsList(params?: MutualFundsListParams): Promise<ApiResponse<MutualFundData[]>>;
/**
* Get list of mutual fund types
* @param params - Parameters for the request
* @returns Promise with list of mutual fund types
*/
getMutualFundsTypeList(params?: MutualFundsTypeListParams): Promise<ApiResponse<MutualFundTypeData[]>>;
/**
* Get list of mutual fund families
* @param params - Parameters for filtering fund families
* @returns Promise with list of mutual fund families
*/
getMutualFundsFamilyList(params?: MutualFundsFamilyListParams): Promise<ApiResponse<MutualFundFamilyData[]>>;
/**
* Get mutual funds market movers
* @param params - Parameters for filtering market movers
* @returns Promise with mutual funds market movers data
*/
getMutualFundsMarketMovers(params?: MutualFundsMarketMoversParams): Promise<ApiResponse<MutualFundMarketMoverData[]>>;
/**
* Get all data for a specific mutual fund
* @param params - Parameters including the fund symbol
* @returns Promise with comprehensive mutual fund data
*/
getMutualFundsAllData(params: MutualFundsAllDataParams): Promise<ApiResponse<MutualFundAllData>>;
/**
* Get summary information for a mutual fund
* @param params - Parameters including the fund symbol
* @returns Promise with mutual fund summary data
*/
getMutualFundsSummary(params: MutualFundsSummaryParams): Promise<ApiResponse<MutualFundSummaryData>>;
/**
* Get performance data for a mutual fund
* @param params - Parameters including the fund symbol
* @returns Promise with mutual fund performance data
*/
getMutualFundsPerformance(params: MutualFundsPerformanceParams): Promise<ApiResponse<MutualFundPerformanceData>>;
/**
* Get risk metrics for a mutual fund
* @param params - Parameters including the fund symbol
* @returns Promise with mutual fund risk data
*/
getMutualFundsRisk(params: MutualFundsRiskParams): Promise<ApiResponse<MutualFundRiskData>>;
/**
* Get ratings for a mutual fund
* @param params - Parameters including the fund symbol
* @returns Promise with mutual fund ratings data
*/
getMutualFundsRatings(params: MutualFundsRatingsParams): Promise<ApiResponse<MutualFundRatingsData>>;
/**
* Get composition and holdings for a mutual fund
* @param params - Parameters including the fund symbol
* @returns Promise with mutual fund composition data
*/
getMutualFundsComposition(params: MutualFundsCompositionParams): Promise<ApiResponse<MutualFundCompositionData>>;
/**
* Get purchase information for a mutual fund
* @param params - Parameters including the fund symbol
* @returns Promise with mutual fund purchase information
*/
getMutualFundsPurchaseInfo(params: MutualFundsPurchaseInfoParams): Promise<ApiResponse<MutualFundPurchaseInfoData>>;
/**
* Get sustainability and ESG data for a mutual fund
* @param params - Parameters including the fund symbol
* @returns Promise with mutual fund sustainability data
*/
getMutualFundsSustainability(params: MutualFundsSustainabilityParams): Promise<ApiResponse<MutualFundSustainabilityData>>;
}