laplace-api 1.4.9 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laplace-api",
-  "version": "1.4.9",
+  "version": "2.0.1",
   "description": "Client library for Laplace API for the US stock market and BIST (Istanbul stock market) fundamental financial data.",
   "main": "index.js",
   "scripts": {

package/src/client/financial_ratios.ts

@@ -14,38 +14,103 @@ export interface StockSectorFinancialRatioComparisonDetail {
 }
 
 export interface StockHistoricalRatios {
-  symbol: string;
-  data: StockHistoricalRatiosData[];
-  formatting: Record<string, StockHistoricalRatiosFormatting>;
+  slug: string;
+  finalValue: number;
+  threeYearGrowth: number;
+  yearGrowth: number;
+  finalSectorValue: number;
+  currency: Currency;
+  format: HistoricalRatiosFormat;
+  name: string;
+  items: StockHistoricalRatiosData[]
 }
 
 export interface StockHistoricalRatiosData {
-  fiscalYear: number;
-  fiscalQuarter: number;
-  values: Record<string, StockHistoricalRatiosValue>;
-}
-
-export interface StockHistoricalRatiosValue {
+  period: string;
   value: number;
-  sectorAverage: number;
+  sectorMean: number;
 }
 
-export interface StockHistoricalRatiosFormatting {
-  name: string;
-  slug: string;
-  precision: number;
-  multiplier: number;
-  suffix: string;
-  prefix: string;
-  interval: string;
-  description: string;
+export enum HistoricalRatiosFormat {
+  CURRENCY = "currency",
+  PERCENTAGE = "percentage",
+  DECIMAL = "decimal"
 }
 
 export enum HistoricalRatiosKey {
-  PriceToEarningsRatio = 'pe-ratio',
-  ReturnOnEquity = 'roe',
+  Revenue = 'satislar',
+  EBITDA = 'ebitda',
+  NetProfit = 'net_kar',
+  GrossMargin = 'gross-margin',
+  NetMargin = 'net-margin',
   ReturnOnAssets = 'roa',
-  ReturnOnCapital = 'roic',
+  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 {
@@ -114,13 +179,13 @@ export class FinancialClient extends Client  {
     });
   }
 
-  async getHistoricalRatios(symbol: string, keys: HistoricalRatiosKey[], region: Region): Promise<StockHistoricalRatios> {
-    const url = new URL(`${this['baseUrl']}/api/v1/stock/historical-ratios`);
+  async getHistoricalRatios(symbol: string, keys: HistoricalRatiosKey[], region: Region): 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('slugs', keys.join(','));
 
-    return this.sendRequest<StockHistoricalRatios>({
+    return this.sendRequest<StockHistoricalRatios[]>({
       method: 'GET',
       url: url.toString(),
     });

package/src/test/financial_ratios.test.ts

@@ -1,9 +1,16 @@
-import { Logger } from 'winston';
-import { LaplaceConfiguration } from '../utilities/configuration';
-import { Client, createClient } from '../client/client';
-import { FinancialClient, HistoricalRatiosKey, FinancialSheetType, FinancialSheetPeriod, Currency } from '../client/financial_ratios';
-import { Region, Locale } from '../client/collections';
-import './client_test_suite';
+import { Logger } from "winston";
+import { LaplaceConfiguration } from "../utilities/configuration";
+import { Client, createClient } from "../client/client";
+import {
+  FinancialClient,
+  HistoricalRatiosKey,
+  FinancialSheetType,
+  FinancialSheetPeriod,
+  Currency,
+} from "../client/financial_ratios";
+import { Region, Locale } from "../client/collections";
+import "./client_test_suite";
+import { equal } from "assert";
 
 describe('FinancialRatios', () => {
   let financialClient: FinancialClient;
@@ -25,16 +32,34 @@ describe('FinancialRatios', () => {
     expect(resp).not.toBeEmpty();
   });
 
-  test('GetHistoricalRatios', async () => {
-    const resp = await financialClient.getHistoricalRatios('TUPRS', [HistoricalRatiosKey.PriceToEarningsRatio], Region.Tr);
+  test("GetHistoricalRatios", async () => {
+    const resp = await financialClient.getHistoricalRatios(
+      "TUPRS",
+      Object.values(HistoricalRatiosKey).flat(),
+      Region.Tr
+    );
     expect(resp).not.toBeEmpty();
-    for (const [_, format] of Object.entries(resp.formatting)) {
-      expect(format.name).not.toBeEmpty();
+    for (const ratio of resp) {
+      expect(typeof ratio.finalValue).toBe("number");
+      expect(typeof ratio.threeYearGrowth).toBe("number");
+      expect(typeof ratio.yearGrowth).toBe("number");
+      expect(typeof ratio.finalSectorValue).toBe("number");
+      expect(equal(ratio.currency, Currency.TRY));
+      expect(typeof ratio.format).toBe("string");
+      expect(typeof ratio.name).toBe("string");
+      expect(ratio.items).not.toBeEmpty();
+      expect(ratio.items.at(0)).toBeTruthy();
+      expect(typeof ratio.items.at(0)?.period).toBe("string");
+      expect(typeof ratio.items.at(0)?.sectorMean).toBe("number");
+      expect(typeof ratio.items.at(0)?.value).toBe("number");
     }
   });
 
-  test('GetHistoricalRatiosDescriptions', async () => {
-    const resp = await financialClient.getHistoricalRatiosDescriptions(Locale.Tr, Region.Tr);
+  test("GetHistoricalRatiosDescriptions", async () => {
+    const resp = await financialClient.getHistoricalRatiosDescriptions(
+      Locale.Tr,
+      Region.Tr
+    );
     expect(resp).not.toBeEmpty();
   });