laplace-api 3.1.0 → 4.1.0

package/src/client/financial_ratios.ts

@@ -1,16 +1,21 @@
-import { Client } from './client';
-import { Region, Locale } from './collections';
+import { Client } from "./client";
+import { Region, Locale } from "./collections";
 
-export interface StockSectorFinancialRatioComparison {
-  metric_name: string;
+export enum RatioComparisonPeerType {
+  Industry = "industry",
+  Sector = "sector",
+}
+
+export interface StockPeerFinancialRatioComparison {
+  metricName: string;
   normalizedValue: number;
-  details: StockSectorFinancialRatioComparisonDetail[];
+  data: StockPeerFinancialRatioComparisonData[];
 }
 
-export interface StockSectorFinancialRatioComparisonDetail {
+export interface StockPeerFinancialRatioComparisonData {
   slug: string;
   value: number;
-  sectorAverage: number;
+  average: number;
 }
 
 export interface StockHistoricalRatios {
@@ -22,7 +27,7 @@ export interface StockHistoricalRatios {
   currency: Currency;
   format: HistoricalRatiosFormat;
   name: string;
-  items: StockHistoricalRatiosData[]
+  items: StockHistoricalRatiosData[];
 }
 
 export interface StockHistoricalRatiosData {
@@ -34,95 +39,96 @@ export interface StockHistoricalRatiosData {
 export enum HistoricalRatiosFormat {
   CURRENCY = "currency",
   PERCENTAGE = "percentage",
-  DECIMAL = "decimal"
+  DECIMAL = "decimal",
 }
 
 export enum HistoricalRatiosKey {
-  Revenue = 'satislar',
-  EBITDA = 'ebitda',
-  NetProfit = 'net_kar',
-  GrossMargin = 'gross-margin',
-  NetMargin = 'net-margin',
-  ReturnOnAssets = 'roa',
-  ReturnOnEquity = 'roe',
-  ReturnOnCapitalEmployed = 'roce',
-  ReturnOnInvestedCapital = 'roic',
-  PriceToEarningsRatio = 'pe-ratio',
-  PriceToEarnings = 'poe',
-  PriceToBookRatio = 'pb-ratio',
-  EnterpriseValueToEBITDA = 'ev-to-ebitda',
-  EnterpriseValueToInvestedCapital = 'evic',
-  InterestCoverage = 'interestCoverage',
-  QuickRatio = 'quick-ratio',
-  LeverageRatio = 'leverage-ratio',
-  DebtToEquity = 'debt-to-equity',
-  RevenueGrowth = 'satis_buyumesi',
-  EBITDAGrowth = 'favok_buyumesi',
-  NetProfitGrowth = 'net_kar_buyumesi',
-  FreeCashFlowGrowth = 'serbest_nakit_akisi_buyumesi',
-  CashConversionCycle = 'cash-conversion-cycle',
-  DaysSalesOutstanding = 'days-sales-outstanding',
-  DaysPayable = 'days-payable',
-  DaysInventory = 'days-inventory',
-
-  EBITDAMargin = 'favok_marji',
-  InventoryTurnover = 'inventory-turnover',
-  DepositGrowth = 'mevduat_buyumesi',
-  NetInterestMargin = 'net_faiz_marji',
-  CompensationGrowth = 'gerceklesen_tazminatlar_buyumesi',
-  PremiumPerCompensation = 'prim_basina_tazminat_orani',
-  EnterpriseValueToOperatingCashFlow = 'evOcf',
-  EarningsBeforeTax = 'ebt',
-  CapitalExpenditure = 'capex',
-  FinancialInvestments = 'financial_investments',
-  RealtimeEarningsPerShare = 'realtime_eps-basic',
-  RealtimeMarketValue = 'realtime_piyasa_degeri',
-  RealtimePriceToBookRatio = 'realtime_pb-ratio',
-  RealtimePriceToEarningsRatio = 'realtime_pe-ratio',
-  CurrentRatio = 'current-ratio',
-  AssetTurnover = 'asset-turnover',
-  TotalOperationalExpense = 'total_operational_expense',
-  TotalOperationalExpenseToGrossProfit = 'total_operational_expense_gross_profit_ratio',
-  CashAndCashEquivalents = 'cash_and_cash_equivalents',
-  CashToAssets = 'cash_to_assets',
-  CapexToNetProfit = 'capex_to_net_profit',
-  RealtimeEnterpriseValueToEBITDA = 'realtime_ev-to-ebitda',
-  ReceivablesTurnover = 'alacak_devir_hizi',
-  EarningsPerShare = 'eps-basic',
-  CreditToAssetRatio = 'kredi_aktif_orani',
-  CreditToDepositRatio = 'kredi_mevduat_orani',
-  TechnicalProfitGrowth = 'teknik_kar_buyumesi',
-  NetEarnedPremiumGrowth = 'net_kazanilan_prim_buyumesi',
-  EBITGrowth = 'ebitGrowth',
-  CashReturnOnInvestedCapital = 'croic',
-  MarketCapitalization = 'piyasa_degeri',
-  ShortTermToLongTermObligations = 'short_term_obligations_long_term_obligations',
-  RetainedEarnings = 'retained_earnings',
-  ThreeYearCAGRFreeCashFlow = 'three_year_cagr_free_cash_flow',
-  LongTermLoansToPeriodicProfitRatio = 'long_term_loans_period_profit_ratio',
-  LongTermLoans = 'long_term_loans',
-  CommercialReceivablesToTotalCurrentAssets = 'commercial_receivables_total_current_assets',
-  StockGrowth = 'stock_growth',
-  FiveYearRetainedEarningsChange = 'five_year_retained_earnings_change',
-  ThreeYearCAGRRetainedEarnings = 'three_year_cagr_retained_earnings',
-  PotentialOperatingCashFlow = 'pocf',
-  FreeCashFlowToEnterpriseValue = 'fcfEv',
-  DebtToDeposit = 'dd',
-  NetDebt = 'net_borc',
-  PaidCapital = 'odenmis_sermaye',
-  FinancialExpensesToEBIT = 'financial_expenses_ebit_ratio'
+  Revenue = "satislar",
+  EBITDA = "ebitda",
+  NetProfit = "net_kar",
+  GrossMargin = "gross-margin",
+  NetMargin = "net-margin",
+  ReturnOnAssets = "roa",
+  ReturnOnEquity = "roe",
+  ReturnOnCapitalEmployed = "roce",
+  ReturnOnInvestedCapital = "roic",
+  PriceToEarningsRatio = "pe-ratio",
+  PriceToEarnings = "poe",
+  PriceToBookRatio = "pb-ratio",
+  EnterpriseValueToEBITDA = "ev-to-ebitda",
+  EnterpriseValueToInvestedCapital = "evic",
+  InterestCoverage = "interestCoverage",
+  QuickRatio = "quick-ratio",
+  LeverageRatio = "leverage-ratio",
+  DebtToEquity = "debt-to-equity",
+  RevenueGrowth = "satis_buyumesi",
+  EBITDAGrowth = "favok_buyumesi",
+  NetProfitGrowth = "net_kar_buyumesi",
+  FreeCashFlowGrowth = "serbest_nakit_akisi_buyumesi",
+  CashConversionCycle = "cash-conversion-cycle",
+  DaysSalesOutstanding = "days-sales-outstanding",
+  DaysPayable = "days-payable",
+  DaysInventory = "days-inventory",
+
+  EBITDAMargin = "favok_marji",
+  InventoryTurnover = "inventory-turnover",
+  DepositGrowth = "mevduat_buyumesi",
+  NetInterestMargin = "net_faiz_marji",
+  CompensationGrowth = "gerceklesen_tazminatlar_buyumesi",
+  PremiumPerCompensation = "prim_basina_tazminat_orani",
+  EnterpriseValueToOperatingCashFlow = "evOcf",
+  EarningsBeforeTax = "ebt",
+  CapitalExpenditure = "capex",
+  FinancialInvestments = "financial_investments",
+  RealtimeEarningsPerShare = "realtime_eps-basic",
+  RealtimeMarketValue = "realtime_piyasa_degeri",
+  RealtimePriceToBookRatio = "realtime_pb-ratio",
+  RealtimePriceToEarningsRatio = "realtime_pe-ratio",
+  CurrentRatio = "current-ratio",
+  AssetTurnover = "asset-turnover",
+  TotalOperationalExpense = "total_operational_expense",
+  TotalOperationalExpenseToGrossProfit = "total_operational_expense_gross_profit_ratio",
+  CashAndCashEquivalents = "cash_and_cash_equivalents",
+  CashToAssets = "cash_to_assets",
+  CapexToNetProfit = "capex_to_net_profit",
+  RealtimeEnterpriseValueToEBITDA = "realtime_ev-to-ebitda",
+  ReceivablesTurnover = "alacak_devir_hizi",
+  EarningsPerShare = "eps-basic",
+  CreditToAssetRatio = "kredi_aktif_orani",
+  CreditToDepositRatio = "kredi_mevduat_orani",
+  TechnicalProfitGrowth = "teknik_kar_buyumesi",
+  NetEarnedPremiumGrowth = "net_kazanilan_prim_buyumesi",
+  EBITGrowth = "ebitGrowth",
+  CashReturnOnInvestedCapital = "croic",
+  MarketCapitalization = "piyasa_degeri",
+  ShortTermToLongTermObligations = "short_term_obligations_long_term_obligations",
+  RetainedEarnings = "retained_earnings",
+  ThreeYearCAGRFreeCashFlow = "three_year_cagr_free_cash_flow",
+  LongTermLoansToPeriodicProfitRatio = "long_term_loans_period_profit_ratio",
+  LongTermLoans = "long_term_loans",
+  CommercialReceivablesToTotalCurrentAssets = "commercial_receivables_total_current_assets",
+  StockGrowth = "stock_growth",
+  FiveYearRetainedEarningsChange = "five_year_retained_earnings_change",
+  ThreeYearCAGRRetainedEarnings = "three_year_cagr_retained_earnings",
+  PotentialOperatingCashFlow = "pocf",
+  FreeCashFlowToEnterpriseValue = "fcfEv",
+  DebtToDeposit = "dd",
+  NetDebt = "net_borc",
+  PaidCapital = "odenmis_sermaye",
+  FinancialExpensesToEBIT = "financial_expenses_ebit_ratio",
 }
 
 export interface StockHistoricalRatiosDescription {
+  id: number;
+  format: string;
+  currency: string;
   slug: string;
+  createdAt: string;
+  updatedAt: string;
   name: string;
-  suffix: string;
-  prefix: string;
-  display: boolean;
-  precision: number;
-  multiplier: number;
   description: string;
-  interval: string;
+  locale: string;
+  isRealtime: boolean;
 }
 
 export interface HistoricalFinancialSheets {
@@ -139,26 +145,24 @@ export interface HistoricalFinancialSheetRow {
   value: number;
   lineCodeId: number;
   indentLevel: number;
-  firstAncestorLineCodeId: number;
-  sectionLineCodeId: number;
 }
 
 export enum FinancialSheetType {
-  IncomeStatement = 'incomeStatement',
-  BalanceSheet = 'balanceSheet',
-  CashFlow = 'cashFlowStatement',
+  IncomeStatement = "incomeStatement",
+  BalanceSheet = "balanceSheet",
+  CashFlow = "cashFlowStatement",
 }
 
 export enum FinancialSheetPeriod {
-  Annual = 'annual',
-  Quarterly = 'quarterly',
-  Cumulative = 'cumulative',
+  Annual = "annual",
+  Quarterly = "quarterly",
+  Cumulative = "cumulative",
 }
 
 export enum Currency {
-  USD = 'USD',
-  TRY = 'TRY',
-  EUR = 'EUR',
+  USD = "USD",
+  TRY = "TRY",
+  EUR = "EUR",
 }
 
 export interface FinancialSheetDate {
@@ -167,38 +171,55 @@ export interface FinancialSheetDate {
   year: number;
 }
 
-export class FinancialClient extends Client  {
-  async getFinancialRatioComparison(symbol: string, region: Region): Promise<StockSectorFinancialRatioComparison[]> {
-    const url = new URL(`${this['baseUrl']}/api/v1/stock/financial-ratio-comparison`);
-    url.searchParams.append('symbol', symbol);
-    url.searchParams.append('region', region);
+export class FinancialClient extends Client {
+  async getFinancialRatioComparison(
+    symbol: string,
+    region: Region,
+    peerType: RatioComparisonPeerType
+  ): Promise<StockPeerFinancialRatioComparison[]> {
+    const url = new URL(
+      `${this["baseUrl"]}/api/v2/stock/financial-ratio-comparison`
+    );
+    url.searchParams.append("symbol", symbol);
+    url.searchParams.append("region", region);
+    url.searchParams.append("peerType", peerType);
 
-    return this.sendRequest<StockSectorFinancialRatioComparison[]>({
-      method: 'GET',
+    return this.sendRequest<StockPeerFinancialRatioComparison[]>({
+      method: "GET",
       url: url.toString(),
     });
   }
 
-  async getHistoricalRatios(symbol: string, keys: HistoricalRatiosKey[], region: Region, locale: Locale): Promise<StockHistoricalRatios[]> {
-    const url = new URL(`${this['baseUrl']}/api/v2/stock/historical-ratios`);
-    url.searchParams.append('symbol', symbol);
-    url.searchParams.append('region', region);
-    url.searchParams.append('locale', locale);
-    url.searchParams.append('slugs', keys.join(','));
+  async getHistoricalRatios(
+    symbol: string,
+    keys: HistoricalRatiosKey[],
+    region: Region,
+    locale: Locale
+  ): Promise<StockHistoricalRatios[]> {
+    const url = new URL(`${this["baseUrl"]}/api/v2/stock/historical-ratios`);
+    url.searchParams.append("symbol", symbol);
+    url.searchParams.append("region", region);
+    url.searchParams.append("locale", locale);
+    url.searchParams.append("slugs", keys.join(","));
 
     return this.sendRequest<StockHistoricalRatios[]>({
-      method: 'GET',
+      method: "GET",
       url: url.toString(),
     });
   }
 
-  async getHistoricalRatiosDescriptions(locale: Locale, region: Region): Promise<StockHistoricalRatiosDescription[]> {
-    const url = new URL(`${this['baseUrl']}/api/v1/stock/historical-ratios/descriptions`);
-    url.searchParams.append('locale', locale);
-    url.searchParams.append('region', region);
+  async getHistoricalRatiosDescriptions(
+    locale: Locale,
+    region: Region
+  ): Promise<StockHistoricalRatiosDescription[]> {
+    const url = new URL(
+      `${this["baseUrl"]}/api/v2/stock/historical-ratios/descriptions`
+    );
+    url.searchParams.append("locale", locale);
+    url.searchParams.append("region", region);
 
     return this.sendRequest<StockHistoricalRatiosDescription[]>({
-      method: 'GET',
+      method: "GET",
       url: url.toString(),
     });
   }
@@ -212,18 +233,37 @@ export class FinancialClient extends Client  {
     currency: Currency,
     region: Region
   ): Promise<HistoricalFinancialSheets> {
-    const url = new URL(`${this['baseUrl']}/api/v2/stock/historical-financial-sheets`);
-    url.searchParams.append('symbol', symbol);
-    url.searchParams.append('from', `${from.year.toString().padStart(4, '0')}-${from.month.toString().padStart(2, '0')}-${from.day.toString().padStart(2, '0')}`);
-    url.searchParams.append('to', `${to.year.toString().padStart(4, '0')}-${to.month.toString().padStart(2, '0')}-${to.day.toString().padStart(2, '0')}`);
-    url.searchParams.append('sheetType', sheetType);
-    url.searchParams.append('periodType', period);
-    url.searchParams.append('currency', currency);
-    url.searchParams.append('region', region);
+    const url = new URL(
+      `${this["baseUrl"]}/api/v3/stock/historical-financial-sheets`
+    );
+    url.searchParams.append("symbol", symbol);
+    url.searchParams.append(
+      "from",
+      `${from.year.toString().padStart(4, "0")}-${from.month
+        .toString()
+        .padStart(2, "0")}-${from.day.toString().padStart(2, "0")}`
+    );
+    url.searchParams.append(
+      "to",
+      `${to.year.toString().padStart(4, "0")}-${to.month
+        .toString()
+        .padStart(2, "0")}-${to.day.toString().padStart(2, "0")}`
+    );
+    url.searchParams.append("sheetType", sheetType);
+    url.searchParams.append("periodType", period);
+    url.searchParams.append("currency", currency);
+    url.searchParams.append("region", region);
+
+    if (
+      sheetType === FinancialSheetType.BalanceSheet &&
+      period !== FinancialSheetPeriod.Cumulative
+    ) {
+      throw new Error("balance sheet is only available for cumulative period");
+    }
 
     return this.sendRequest<HistoricalFinancialSheets>({
-      method: 'GET',
+      method: "GET",
       url: url.toString(),
     });
   }
-}
+}

package/src/client/funds.ts

@@ -0,0 +1,139 @@
+import { Client } from "./client";
+import { Region } from "./collections";
+import { AssetType } from "./stocks";
+
+export enum FundType {
+  STOCK_UMBRELLA_FUND = "STOCK_UMBRELLA_FUND",
+  VARIABLE_UMBRELLA_FUND = "VARIABLE_UMBRELLA_FUND",
+  PARTICIPATION_UMBRELLA_FUND = "PARTICIPATION_UMBRELLA_FUND",
+  FLEXIBLE_UMBRELLA_FUND = "FLEXIBLE_UMBRELLA_FUND",
+  FUND_BASKET_UMBRELLA_FUND = "FUND_BASKET_UMBRELLA_FUND",
+  MONEY_MARKET_UMBRELLA_FUND = "MONEY_MARKET_UMBRELLA_FUND",
+  PRECIOUS_METALS_UMBRELLA_FUND = "PRECIOUS_METALS_UMBRELLA_FUND",
+  DEBT_INSTRUMENTS_UMBRELLA_FUND = "DEBT_INSTRUMENTS_UMBRELLA_FUND",
+  MIXED_UMBRELLA_FUND = "MIXED_UMBRELLA_FUND",
+  UNKNOWN_FUND_TYPE = "UNKNOWN_FUND_TYPE",
+}
+
+export interface Fund {
+  assetType: AssetType;
+  name: string;
+  symbol: string;
+  active: boolean;
+  managementFee: number;
+  riskLevel: number;
+  fundType: FundType;
+  ownerSymbol: string;
+}
+
+export interface FundStats {
+  yearBeta: number;
+  yearStdev: number;
+  ytdReturn: number;
+  yearMomentum: number;
+  yearlyReturn: number;
+  monthlyReturn: number;
+  fiveYearReturn: number;
+  sixMonthReturn: number;
+  threeYearReturn: number;
+  threeMonthReturn: number;
+}
+
+export enum FundContentType {
+  BIST_STOCK = "BIST_STOCK",
+  OTHER_STOCK = "OTHER_STOCK",
+  UNKNOWN = "UNKNOWN",
+}
+
+export enum FundAssetCategory {
+  OTHER = "OTHER",
+  EQUITY = "EQUITY",
+  LIQUID_DEPOSIT = "LIQUID_DEPOSIT",
+  FUTURES_CASH_COLLATERAL = "FUTURES_CASH_COLLATERAL",
+  INVESTMENT_FUNDS = "INVESTMENT_FUNDS",
+  PARTICIPATION_ACCOUNT = "PARTICIPATION_ACCOUNT",
+  PRECIOUS_METALS = "PRECIOUS_METALS",
+  CORPORATE_BOND = "CORPORATE_BOND",
+  CURRENCY = "CURRENCY",
+  PUBLIC_EXTERNAL_DEBT_SECURITIES = "PUBLIC_EXTERNAL_DEBT_SECURITIES",
+  PRIVATE_SECTOR_EXTERNAL_DEBT_SECURITIES = "PRIVATE_SECTOR_EXTERNAL_DEBT_SECURITIES",
+  PUBLIC_LEASE_CERTIFICATES = "PUBLIC_LEASE_CERTIFICATES",
+  PRIVATE_SECTOR_LEASE_CERTIFICATES = "PRIVATE_SECTOR_LEASE_CERTIFICATES",
+  FOREIGN_EXCHANGE_TRADED_FUNDS = "FOREIGN_EXCHANGE_TRADED_FUNDS",
+  PUBLIC_LEASE_CERTIFICATES_CURRENCY = "PUBLIC_LEASE_CERTIFICATES_CURRENCY",
+  GOVERNMENT_BOND = "GOVERNMENT_BOND",
+  PRIVATE_SECTOR_LEASE_CERTIFICATES_CURRENCY = "PRIVATE_SECTOR_LEASE_CERTIFICATES_CURRENCY",
+  UNKNOWN = "UNKNOWN",
+}
+
+export interface FundAsset {
+  type: FundContentType;
+  symbol: string;
+  wholePercentage: number;
+  categoryPercentage: number;
+}
+
+export interface FundDistribution {
+  categories: FundCategoryDistribution[];
+}
+
+export interface FundCategoryDistribution {
+  category: FundAssetCategory;
+  percentage: number;
+  assets?: FundAsset[];
+}
+
+export enum HistoricalFundPricePeriod {
+  OneWeek = "1H",
+  OneMonth = "1A",
+  ThreeMonth = "3A",
+  OneYear = "1Y",
+  ThreeYear = "3Y",
+  FiveYear = "5Y",
+}
+
+export interface FundHistoricalPrice {
+  aum: number;
+  date: string;
+  price: number;
+  shareCount: number;
+  investorCount: number;
+}
+
+export class FundsClient extends Client {
+  async getFunds(region: Region, page: number, pageSize: number) {
+    return this.sendRequest<Fund[]>({
+      method: "GET",
+      url: `/api/v1/fund`,
+      params: { region, page, pageSize },
+    });
+  }
+
+  async getFundStats(symbol: string, region: Region) {
+    return this.sendRequest<FundStats>({
+      method: "GET",
+      url: `/api/v1/fund/stats`,
+      params: { symbol, region },
+    });
+  }
+
+  async getFundDistribution(symbol: string, region: Region) {
+    return this.sendRequest<FundDistribution>({
+      method: "GET",
+      url: `/api/v1/fund/distribution`,
+      params: { symbol, region },
+    });
+  }
+
+  async getHistoricalFundPrices(
+    symbol: string,
+    region: Region,
+    period: HistoricalFundPricePeriod
+  ) {
+    return this.sendRequest<FundHistoricalPrice[]>({
+      method: "GET",
+      url: `/api/v1/fund/price`,
+      params: { symbol, region, period },
+    });
+  }
+}

package/src/client/key-insights.ts

@@ -0,0 +1,17 @@
+import { Client } from "./client";
+import { Region } from "./collections";
+
+export interface KeyInsight {
+  symbol: string;
+  insight: string;
+}
+
+export class KeyInsightClient extends Client {
+  async getKeyInsights(symbol: string, region: Region) {
+    return this.sendRequest<KeyInsight>({
+      method: "GET",
+      url: "/api/v1/key-insight",
+      params: { symbol, region },
+    });
+  }
+}