laplace-api 4.0.0 → 4.1.0

package/src/client/collections.ts

@@ -1,5 +1,5 @@
 import { Client } from './client';
-import { Stock } from './stocks';
+import { HistoricalPricePeriod, PriceDataPoint, Stock } from './stocks';
 
 export enum CollectionType {
   Sector = 'sector',
@@ -42,52 +42,81 @@ export interface CollectionDetail extends Collection {
   stocks: Stock[];
 }
 
+export interface CollectionPriceGraph {
+	previous_close: number;
+	graph: PriceDataPoint[];
+}
+
 export class CollectionClient extends Client {
-  private async getAllCollectionsPrivate(collectionType: CollectionType, region: Region, locale: Locale): Promise<Collection[]> {
+  async getAllSectors(region: Region, locale: Locale): Promise<Collection[]> {
     return this.sendRequest<Collection[]>({
       method: 'GET',
-      url: `/api/v1/${collectionType}`,
+      url: `/api/v1/sector`,
       params: { region, locale },
     });
   }
-
-  private async getCollectionDetailPrivate(id: string, collectionType: CollectionType, region: Region, locale: Locale): Promise<CollectionDetail> {
-    return this.sendRequest<CollectionDetail>({
+ 
+  async getAllIndustries(region: Region, locale: Locale): Promise<Collection[]> {
+    return this.sendRequest<Collection[]>({
       method: 'GET',
-      url: `/api/v1/${collectionType}/${id}`,
+      url: `/api/v1/industry`,
       params: { region, locale },
     });
   }
-
-  async getAllSectors(region: Region, locale: Locale): Promise<Collection[]> {
-    return this.getAllCollectionsPrivate(CollectionType.Sector, region, locale);
-  }
-
-  async getAllIndustries(region: Region, locale: Locale): Promise<Collection[]> {
-    return this.getAllCollectionsPrivate(CollectionType.Industry, region, locale);
-  }
-
+ 
   async getAllThemes(region: Region, locale: Locale): Promise<Collection[]> {
-    return this.getAllCollectionsPrivate(CollectionType.Theme, region, locale);
+    return this.sendRequest<Collection[]>({
+      method: 'GET',
+      url: `/api/v1/theme`,
+      params: { region, locale },
+    });
   }
-
+ 
   async getAllCollections(region: Region, locale: Locale): Promise<Collection[]> {
-    return this.getAllCollectionsPrivate(CollectionType.Collection, region, locale);
+    return this.sendRequest<Collection[]>({
+      method: 'GET',
+      url: `/api/v1/collection`,
+      params: { region, locale },
+    });
   }
-
+ 
   async getSectorDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
-    return this.getCollectionDetailPrivate(id, CollectionType.Sector, region, locale);
+    return this.sendRequest<CollectionDetail>({
+      method: 'GET',
+      url: `/api/v1/sector/${id}`,
+      params: { region, locale },
+    });
   }
-
+ 
   async getIndustryDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
-    return this.getCollectionDetailPrivate(id, CollectionType.Industry, region, locale);
+    return this.sendRequest<CollectionDetail>({
+      method: 'GET',
+      url: `/api/v1/industry/${id}`,
+      params: { region, locale },
+    });
   }
-
+ 
   async getThemeDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
-    return this.getCollectionDetailPrivate(id, CollectionType.Theme, region, locale);
+    return this.sendRequest<CollectionDetail>({
+      method: 'GET',
+      url: `/api/v1/theme/${id}`,
+      params: { region, locale },
+    });
   }
-
+ 
   async getCollectionDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
-    return this.getCollectionDetailPrivate(id, CollectionType.Collection, region, locale);
+    return this.sendRequest<CollectionDetail>({
+      method: 'GET',
+      url: `/api/v1/collection/${id}`,
+      params: { region, locale },
+    });
+  }
+
+  async getAggregateGraph(period: HistoricalPricePeriod, sectorId: string, industryId: string, collectionId: string, region: Region): Promise<CollectionPriceGraph> {
+    return this.sendRequest<CollectionPriceGraph>({
+      method: 'GET',
+      url: `/api/v1/aggregate/graph`,
+      params: { period, sectorId, industryId, collectionId, region },
+    });
   }
-}
+ }

package/src/client/financial_fundamentals.ts

@@ -75,13 +75,10 @@ export class FinancialFundamentalsClient extends Client {
     symbol: string,
     region: Region
   ): Promise<StockDividend[]> {
-    const url = new URL(`${this["baseUrl"]}/api/v2/stock/dividends`);
-    url.searchParams.append("symbol", symbol);
-    url.searchParams.append("region", region);
-
     return this.sendRequest<StockDividend[]>({
       method: 'GET',
-      url: url.toString(),
+      url: "/api/v2/stock/dividends",
+      params: { symbol, region }
     });
   }
 

package/src/client/financial_ratios.ts

@@ -3,7 +3,7 @@ import { Region, Locale } from "./collections";
 
 export enum RatioComparisonPeerType {
   Industry = "industry",
-  Sector = "sector"
+  Sector = "sector",
 }
 
 export interface StockPeerFinancialRatioComparison {
@@ -43,79 +43,79 @@ export enum HistoricalRatiosFormat {
 }
 
 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 {
@@ -148,21 +148,21 @@ export interface HistoricalFinancialSheetRow {
 }
 
 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 {
@@ -203,7 +203,7 @@ export class FinancialClient extends Client {
     url.searchParams.append("slugs", keys.join(","));
 
     return this.sendRequest<StockHistoricalRatios[]>({
-      method: 'GET',
+      method: "GET",
       url: url.toString(),
     });
   }
@@ -219,7 +219,7 @@ export class FinancialClient extends Client {
     url.searchParams.append("region", region);
 
     return this.sendRequest<StockHistoricalRatiosDescription[]>({
-      method: 'GET',
+      method: "GET",
       url: url.toString(),
     });
   }
@@ -233,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/live-price-web-socket.ts

@@ -1,3 +1,30 @@
+import { Logger } from "winston";
+import { LaplaceConfiguration } from "../utilities/configuration";
+import { Client } from "./client";
+
+interface WebSocketUrlResponse {
+  url: string;
+}
+
+interface WebSocketUrlParams {
+  externalUserId: string;
+  feeds: LivePriceFeed[];
+}
+
+export enum AccessorType {
+  User = "user",
+}
+
+interface UpdateUserDetailsParams {
+  externalUserID: string;
+  firstName?: string;
+  lastName?: string;
+  address?: string;
+  city?: string;
+  countryCode?: string;
+  accessorType?: AccessorType;
+  active: boolean;
+}
 
 interface RawBISTStockLiveData {
   _id: number;
@@ -88,7 +115,7 @@ export class WebSocketError extends Error {
   }
 }
 
-export class LivePriceWebSocketClient {
+export class LivePriceWebSocketClient extends Client {
   private ws: WebSocket | null = null;
   private subscriptionCounter = 0;
   private subscriptions = new Map<
@@ -99,7 +126,10 @@ export class LivePriceWebSocketClient {
       feed: LivePriceFeed;
     }
   >();
-  private symbolLastData = new Map<string, BISTStockLiveData | USStockLiveData>();
+  private symbolLastData = new Map<
+    string,
+    BISTStockLiveData | USStockLiveData
+  >();
   private reconnectAttempts = 0;
   private reconnectTimeout: NodeJS.Timeout | null = null;
   private isClosed: boolean = false;
@@ -110,8 +140,19 @@ export class LivePriceWebSocketClient {
   private lastMessageTimestamp: number = 0;
   private inactivityCheckInterval: NodeJS.Timeout | null = null;
   private readonly INACTIVITY_TIMEOUT = 15000;
+  private externalUserId: string | null = null;
+  private feeds: LivePriceFeed[] | null = null;
 
-  constructor(options: WebSocketOptions = {}) {
+  constructor(
+    feeds: LivePriceFeed[],
+    externalUserId: string,
+    cfg: LaplaceConfiguration,
+    logger: Logger,
+    options: WebSocketOptions = {}
+  ) {
+    super(cfg, logger);
+    this.feeds = feeds;
+    this.externalUserId = externalUserId;
     this.options = {
       enableLogging: true,
       logLevel: LogLevel.Error,
@@ -128,17 +169,17 @@ export class LivePriceWebSocketClient {
       clearInterval(this.inactivityCheckInterval);
       this.inactivityCheckInterval = null;
     }
- 
-    this.inactivityCheckInterval = setInterval(async ()=> {
+
+    this.inactivityCheckInterval = setInterval(async () => {
       if (Date.now() - this.lastMessageTimestamp >= this.INACTIVITY_TIMEOUT) {
         this.stopInactivityInterval();
         try {
           this.attemptReconnect();
-        } catch(error) {
+        } catch (error) {
           this.log(`Failed to reconnect: ${error}`, "error");
         }
       }
-    }, this.INACTIVITY_TIMEOUT)
+    }, this.INACTIVITY_TIMEOUT);
   }
 
   private stopInactivityInterval() {
@@ -175,12 +216,43 @@ export class LivePriceWebSocketClient {
     }
   }
 
-  async connect(url: string): Promise<WebSocket> {
+  async updateUserDetails(params: UpdateUserDetailsParams): Promise<void> {
+    const url = new URL(`${this["baseUrl"]}/api/v1/ws/user`);
+
+    await this.sendRequest<void>({
+      method: "PUT",
+      url: url.toString(),
+      data: params,
+    });
+  }
+
+  private async getWebSocketUrl(): Promise<string> {
+    const url = new URL(`${this["baseUrl"]}/api/v2/ws/url`);
+
+    const params: WebSocketUrlParams = {
+      externalUserId: this.externalUserId!,
+      feeds: this.feeds!,
+    };
+
+    const response = await this.sendRequest<WebSocketUrlResponse>({
+      method: "POST",
+      url: url.toString(),
+      data: params,
+    });
+
+    return response.url;
+  }
+
+  async connect(url?: string): Promise<WebSocket> {
     this.log("Connecting to WebSocket...");
-    this.wsUrl = url;
+    if (!this.externalUserId || !this.feeds) {
+      throw new Error("External user ID and feeds are required");
+    }
+
+    this.wsUrl = url || (await this.getWebSocketUrl());
 
     if (!this.ws || this.ws.readyState === WebSocket.CLOSED) {
-      this.ws = new WebSocket(url);
+      this.ws = new WebSocket(this.wsUrl);
       this.connectPromise = this.setupWebSocket();
 
       await this.connectPromise;
@@ -419,7 +491,8 @@ export class LivePriceWebSocketClient {
       if (symbolHandlers.length === 1) {
         symbolsToAdd.push(symbol);
       } else if (symbolHandlers.length > 1) {
-        const lastData: BISTStockLiveData | USStockLiveData | undefined = this.symbolLastData.get(symbol);
+        const lastData: BISTStockLiveData | USStockLiveData | undefined =
+          this.symbolLastData.get(symbol);
         if (lastData) {
           typedHandler(lastData);
         }