laplace-api 4.7.0 → 5.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laplace-api",
-  "version": "4.7.0",
+  "version": "5.1.0",
   "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/broker.ts

@@ -33,6 +33,8 @@ export interface BrokerStock {
   id: string;
   assetType: AssetType;
   assetClass: AssetClass;
+  logoUrl?: string;
+  exchange?: string;
 }
 
 export interface BrokerStats {
@@ -59,8 +61,8 @@ export class BrokerClient extends Client {
 
   async getBrokers(
     region: Region,
-    page: number,
     size: number,
+    page?: number,
     assetClass?: AssetClass
   ): Promise<PaginatedResponse<Broker>> {
     return this.sendRequest<PaginatedResponse<Broker>>({
@@ -68,9 +70,9 @@ export class BrokerClient extends Client {
       url: "/api/v1/brokers",
       params: {
         region,
-        page,
         size,
-        assetClass
+        ...(page != null && { page }),
+        ...(assetClass != null && { assetClass }),
       },
     });
   }
@@ -81,8 +83,8 @@ export class BrokerClient extends Client {
     sortDirection: SortDirection,
     fromDate: string,
     toDate: string,
-    page: number,
-    size: number
+    size: number,
+    page?: number,
   ): Promise<BrokerList> {
     return this.sendRequest<BrokerList>({
       method: "GET",
@@ -93,8 +95,8 @@ export class BrokerClient extends Client {
         sortDirection,
         fromDate,
         toDate,
-        page,
         size,
+        ...(page != null && { page }),
       },
     });
   }
@@ -105,8 +107,8 @@ export class BrokerClient extends Client {
     sortDirection: SortDirection,
     fromDate: string,
     toDate: string,
-    page: number,
-    size: number
+    size: number,
+    page?: number,
   ): Promise<BrokerList> {
     return this.sendRequest<BrokerList>({
       method: "GET",
@@ -117,8 +119,8 @@ export class BrokerClient extends Client {
         sortDirection,
         fromDate,
         toDate,
-        page,
         size,
+        ...(page != null && { page }),
       },
     });
   }
@@ -130,21 +132,20 @@ export class BrokerClient extends Client {
     sortDirection: SortDirection,
     fromDate: string,
     toDate: string,
-    page: number,
-    size: number
+    size: number,
+    page?: number,
   ): Promise<BrokerList> {
     return this.sendRequest<BrokerList>({
       method: "GET",
       url: `/api/v1/brokers/${symbol}`,
       params: {
-        symbol,
         region,
         sortBy,
         sortDirection,
         fromDate,
         toDate,
-        page,
         size,
+        ...(page != null && { page }),
       },
     });
   }
@@ -156,21 +157,20 @@ export class BrokerClient extends Client {
     sortDirection: SortDirection,
     fromDate: string,
     toDate: string,
-    page: number,
-    size: number
+    size: number,
+    page?: number,
   ): Promise<BrokerList> {
     return this.sendRequest<BrokerList>({
       method: "GET",
       url: `/api/v1/brokers/stock/${symbol}`,
       params: {
-        symbol,
         region,
         sortBy,
         sortDirection,
         fromDate,
         toDate,
-        page,
         size,
+        ...(page != null && { page }),
       },
     });
   }

package/src/client/capital_increase.ts

@@ -8,7 +8,7 @@ export interface PaginatedResponse<T> {
 
 export interface CapitalIncrease {
   id: number;
-  boardDecisionDate: string;
+  boardDecisionDate: string | null;
   registeredCapitalCeiling: string;
   currentCapital: string;
   targetCapital: string;
@@ -38,39 +38,38 @@ export interface CapitalIncrease {
 
 export class CapitalIncreaseClient extends Client {
   async getAllCapitalIncreases(
-    page: number,
     size: number,
-    region: Region
+    region: Region,
+    page?: number,
   ): Promise<PaginatedResponse<CapitalIncrease>> {
     return this.sendRequest<PaginatedResponse<CapitalIncrease>>({
       method: "GET",
       url: "/api/v1/capital-increase/all",
-      params: { region, page, size },
+      params: { region, size, ...(page != null && { page }) },
     });
   }
 
   async getCapitalIncreasesForInstrument(
     symbol: string,
-    page: number,
     size: number,
-    region: Region
+    region: Region,
+    page?: number,
   ): Promise<PaginatedResponse<CapitalIncrease>> {
     return this.sendRequest<PaginatedResponse<CapitalIncrease>>({
       method: 'GET',
       url: `/api/v1/capital-increase/${symbol}`,
-      params: { region, page, size },
+      params: { region, size, ...(page != null && { page }) },
     });
   }
 
   async getActiveRightsForInstrument(
     symbol: string,
-    date: string,
-    region: Region
+    date?: string,
   ): Promise<CapitalIncrease[]> {
     return this.sendRequest<CapitalIncrease[]>({
       method: 'GET',
       url: `/api/v1/rights/active/${symbol}`,
-      params: { date, region },
+      params: { ...(date != null && { date }) },
     });
   }
 }

package/src/client/client.ts

@@ -10,8 +10,8 @@ export class Client {
   private apiKey: string;
   private logger: Logger;
 
-  constructor(cfg: LaplaceConfiguration, logger: Logger) {
-    this.cli = axios.create();
+  constructor(cfg: LaplaceConfiguration, logger: Logger, cli?: AxiosInstance) {
+    this.cli = cli ?? axios.create();
     this.baseUrl = cfg.baseURL;
     this.apiKey = cfg.apiKey;
     this.logger = logger;
@@ -41,54 +41,54 @@ export class Client {
     }
   }
 
-sendSSERequest<T>(url: string): { events: AsyncIterable<T>, cancel: () => void } {
-  const source = axios.CancelToken.source();
-  var apiKey = this.apiKey;
+  sendSSERequest<T>(url: string): { events: AsyncIterable<T>, cancel: () => void } {
+    const source = axios.CancelToken.source();
+    const apiKey = this.apiKey;
 
-  const events: AsyncIterable<T> = {
-    async *[Symbol.asyncIterator]() {
-      try {
-        const response = await axios.get(url, {
-          headers: {
-            Authorization: `Bearer ${apiKey}`,
-          },
-          responseType: 'stream',
-          cancelToken: source.token,
-        });
+    const events: AsyncIterable<T> = {
+      async *[Symbol.asyncIterator]() {
+        try {
+          const response = await axios.get(url, {
+            headers: {
+              Authorization: `Bearer ${apiKey}`,
+            },
+            responseType: 'stream',
+            cancelToken: source.token,
+          });
 
-        const reader = response.data;
-        const decoder = new TextDecoder();
+          const reader = response.data;
+          const decoder = new TextDecoder();
 
-        for await (const chunk of reader) {
-          const text = decoder.decode(chunk);
-          const lines = text.split('\n').filter(line => line.trim() !== '');
+          for await (const chunk of reader) {
+            const text = decoder.decode(chunk);
+            const lines = text.split('\n').filter(line => line.trim() !== '');
 
-          for (const line of lines) {
-            if (line.startsWith('data: ')) {
-              const data = line.slice(6);
-              try {
-                const parsedData = JSON.parse(data) as T;
-                yield parsedData;
-              } catch (error) {
-                console.error(`Error parsing event data: ${error}`);
+            for (const line of lines) {
+              if (line.startsWith('data: ')) {
+                const data = line.slice(6);
+                try {
+                  const parsedData = JSON.parse(data) as T;
+                  yield parsedData;
+                } catch (error) {
+                  console.error(`Error parsing event data: ${error}`);
+                }
               }
             }
           }
+        } catch (error) {
+          if (!axios.isCancel(error)) {
+            console.error(`SSE error: ${error}`);
+          }
         }
-      } catch (error) {
-        if (!axios.isCancel(error)) {
-          console.error(`SSE error: ${error}`);
-        }
-      }
-    },
-  };
+      },
+    };
 
-  const cancel = () => {
-    source.cancel('Request cancelled by user');
-  };
+    const cancel = () => {
+      source.cancel('Request cancelled by user');
+    };
 
-  return { events, cancel };
-}
+    return { events, cancel };
+  }
 }
 
 export function createClient(cfg: LaplaceConfiguration, logger: Logger): Client {

package/src/client/collections.ts

@@ -1,5 +1,5 @@
 import { Client } from './client';
-import { HistoricalPricePeriod, PriceDataPoint, Stock } from './stocks';
+import { PriceDataPoint, Stock } from './stocks';
 
 export enum CollectionType {
   Sector = 'sector',
@@ -23,11 +23,23 @@ export enum SortBy {
   PriceChange = "price_change"
 }
 
+export enum AggregateGraphPeriod {
+  OneDay = '1G',
+  OneWeek = '1H',
+  OneMonth = '1A',
+  ThreeMonth = '3A',
+  OneYear = '1Y',
+  TwoYear = '2Y',
+  ThreeYear = '3Y',
+  FiveYear = '5Y',
+}
+
 export interface Collection {
   id: string;
   title: string;
   description?: string;
-  region?: Region[];
+  region: Region[];
+  locale?: Locale;
   assetClass?: string;
   imageUrl: string;
   avatarUrl: string;
@@ -80,39 +92,39 @@ export class CollectionClient extends Client {
     });
   }
  
-  async getSectorDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
+  async getSectorDetail(id: string, region: Region, locale: Locale, sortBy?: SortBy): Promise<CollectionDetail> {
     return this.sendRequest<CollectionDetail>({
       method: 'GET',
       url: `/api/v1/sector/${id}`,
-      params: { region, locale },
+      params: { region, locale, ...(sortBy != null && { sortBy }) },
     });
   }
- 
-  async getIndustryDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
+
+  async getIndustryDetail(id: string, region: Region, locale: Locale, sortBy?: SortBy): Promise<CollectionDetail> {
     return this.sendRequest<CollectionDetail>({
       method: 'GET',
       url: `/api/v1/industry/${id}`,
-      params: { region, locale },
+      params: { region, locale, ...(sortBy != null && { sortBy }) },
     });
   }
- 
-  async getThemeDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
+
+  async getThemeDetail(id: string, region: Region, locale: Locale, sortBy?: SortBy): Promise<CollectionDetail> {
     return this.sendRequest<CollectionDetail>({
       method: 'GET',
       url: `/api/v1/theme/${id}`,
-      params: { region, locale },
+      params: { region, locale, ...(sortBy != null && { sortBy }) },
     });
   }
- 
-  async getCollectionDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
+
+  async getCollectionDetail(id: string, region: Region, locale: Locale, sortBy?: SortBy): Promise<CollectionDetail> {
     return this.sendRequest<CollectionDetail>({
       method: 'GET',
       url: `/api/v1/collection/${id}`,
-      params: { region, locale },
+      params: { region, locale, ...(sortBy != null && { sortBy }) },
     });
   }
 
-  async getAggregateGraph(period: HistoricalPricePeriod, sectorId: string, industryId: string, collectionId: string, region: Region): Promise<CollectionPriceGraph> {
+  async getAggregateGraph(period: AggregateGraphPeriod, sectorId: string, industryId: string, collectionId: string, region: Region): Promise<CollectionPriceGraph> {
     return this.sendRequest<CollectionPriceGraph>({
       method: 'GET',
       url: `/api/v1/aggregate/graph`,

package/src/client/custom_theme.ts

@@ -1,15 +1,12 @@
 import { Client } from './client';
 import { Collection, CollectionDetail, CollectionType, Region, Locale, SortBy } from './collections';
+import { LocaleString } from './stocks';
 
 export enum CollectionStatus {
   Active = 'active',
   Inactive = 'inactive',
 }
 
-export interface LocaleString {
-  [key: string]: string;
-}
-
 export interface CreateCustomThemeParams {
   title: LocaleString;
   description?: LocaleString;
@@ -35,21 +32,25 @@ export interface UpdateCustomThemeParams {
 }
 
 export class CustomThemeClient extends Client {
-  private async getAllCollectionsPrivate(collectionType: CollectionType, locale: Locale): Promise<Collection[]> {
+  private async getAllCollectionsPrivate(collectionType: CollectionType, locale: Locale, region?: Region): Promise<Collection[]> {
+    const params = {
+      locale,
+      ...(region != null && { region }),
+    };
+
     return this.sendRequest<Collection[]>({
       method: 'GET',
       url: `/api/v1/${collectionType}`,
-      params: { locale },
+      params: params,
     });
   }
 
   private async getCollectionDetailPrivate(id: string, collectionType: CollectionType, locale: Locale, sortBy: SortBy | null): Promise<CollectionDetail> {
-    var params = {}
-    if (sortBy) {
-      params = { locale, sortBy };
-    } else {  
-      params = { locale };
-    }
+    const params = {
+      locale,
+      ...(sortBy != null && { sortBy }),
+    };
+    
     return this.sendRequest<CollectionDetail>({
       method: 'GET',
       url: `/api/v1/${collectionType}/${id}`,
@@ -58,8 +59,8 @@ export class CustomThemeClient extends Client {
   }
 
 
-  async getAllCustomThemes(locale: Locale): Promise<Collection[]> {
-    return this.getAllCollectionsPrivate(CollectionType.CustomTheme, locale);
+  async getAllCustomThemes(locale: Locale, region?: Region): Promise<Collection[]> {
+    return this.getAllCollectionsPrivate(CollectionType.CustomTheme, locale, region);
   }
 
   async getCustomThemeDetail(id: string, locale: Locale, sortBy: SortBy | null): Promise<CollectionDetail> {

package/src/client/financial_fundamentals.ts

@@ -1,9 +1,11 @@
 import { Client } from './client';
 import { Region } from './collections';
+import { Currency } from './financial_ratios';
 import { AssetClass, AssetType } from './stocks';
 
 export interface StockDividend {
   date: string;
+  currency: Currency;
   netAmount: number;
   netRatio: number;
   grossAmount: number;
@@ -14,28 +16,28 @@ export interface StockDividend {
 }
 
 export interface StockStats {
+  ytdReturn: number;
+  yearlyReturn: number;
+  "3YearReturn": number;
+  "5YearReturn": number;
+  "3MonthReturn": number;
+  monthlyReturn: number;
+  weeklyReturn: number;
+  symbol: string;
+  dailyChange: number;
   previousClose?: number;
   marketCap?: number;
   peRatio?: number;
   pbRatio?: number;
   yearLow?: number;
   yearHigh?: number;
-  weeklyReturn?: number;
-  monthlyReturn?: number;
-  "3MonthReturn"?: number;
-  ytdReturn?: number;
-  yearlyReturn?: number;
-  "3YearReturn"?: number;
-  "5YearReturn"?: number;
-  symbol: string;
   latestPrice?: number;
-  dailyChange?: number;
-  dayLow?: number;
   dayHigh?: number;
-  lowerPriceLimit?: number;
-  upperPriceLimit?: number;
+  dayLow?: number;
   dayOpen?: number;
   eps?: number;
+  lowerPriceLimit?: number;
+  upperPriceLimit?: number;
 }
 
 export enum StockStatsKey {
@@ -83,30 +85,30 @@ export class FinancialFundamentalsClient extends Client {
   }
 
   async getStockStats(symbols: string[], region: Region): Promise<StockStats[]> {
-    const url = new URL(`${this['baseUrl']}/api/v2/stock/stats`);
-    url.searchParams.append('symbols', symbols.join(','));
-    url.searchParams.append('region', region);
-
     return this.sendRequest<StockStats[]>({
       method: 'GET',
-      url: url.toString(),
+      url: '/api/v2/stock/stats',
+      params: {
+        symbols: symbols.join(','),
+        region,
+      },
     });
   }
 
-  async getTopMovers(region: Region, page: number, pageSize: number, direction: TopMoverDirection, assetType?: AssetType,
+  async getTopMovers(region: Region, pageSize: number, direction: TopMoverDirection, page?: number, assetType?: AssetType,
     assetClass?: AssetClass
   ): Promise<TopMover[]> {
-    const url = new URL(`${this['baseUrl']}/api/v2/stock/top-movers`);
-    url.searchParams.append('region', region);
-    url.searchParams.append('page', page.toString());
-    url.searchParams.append('pageSize', pageSize.toString());
-    url.searchParams.append('direction', direction);
-    if (assetType) url.searchParams.append('assetType', assetType);
-    if (assetClass) url.searchParams.append("assetClass", assetClass);
-
     return this.sendRequest<TopMover[]>({
       method: 'GET',
-      url: url.toString(),
+      url: '/api/v2/stock/top-movers',
+      params: {
+        region,
+        pageSize,
+        direction,
+        ...(assetType != null && { assetType }),
+        ...(assetClass != null && { assetClass }),
+        ...(page != null && { page }),
+      },
     });
   }
 }

package/src/client/financial_ratios.ts

@@ -121,13 +121,13 @@ export enum HistoricalRatiosKey {
 export interface StockHistoricalRatiosDescription {
   id: number;
   format: string;
-  currency: string;
+  currency: Currency;
   slug: string;
   createdAt: string;
   updatedAt: string;
   name: string;
   description: string;
-  locale: string;
+  locale: Locale;
   isRealtime: boolean;
 }
 
@@ -177,16 +177,10 @@ export class FinancialClient extends Client {
     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<StockPeerFinancialRatioComparison[]>({
       method: "GET",
-      url: url.toString(),
+      url: "/api/v2/stock/financial-ratio-comparison",
+      params: { symbol, region, peerType },
     });
   }
 
@@ -194,17 +188,17 @@ export class FinancialClient extends Client {
     symbol: string,
     keys: HistoricalRatiosKey[],
     region: Region,
-    locale: Locale
+    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",
-      url: url.toString(),
+      url: "/api/v2/stock/historical-ratios",
+      params: {
+        symbol,
+        region,
+        slugs: keys.join(","),
+        ...(locale != null && { locale }),
+      },
     });
   }
 
@@ -212,15 +206,10 @@ export class FinancialClient extends Client {
     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",
-      url: url.toString(),
+      url: "/api/v2/stock/historical-ratios/descriptions",
+      params: { locale, region },
     });
   }
 
@@ -233,27 +222,6 @@ export class FinancialClient extends Client {
     currency: Currency,
     region: Region
   ): Promise<HistoricalFinancialSheets> {
-    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
@@ -261,9 +229,23 @@ export class FinancialClient extends Client {
       throw new Error("balance sheet is only available for cumulative period");
     }
 
+    const formatDate = (d: FinancialSheetDate) =>
+      `${d.year.toString().padStart(4, "0")}-${d.month
+        .toString()
+        .padStart(2, "0")}-${d.day.toString().padStart(2, "0")}`;
+
     return this.sendRequest<HistoricalFinancialSheets>({
       method: "GET",
-      url: url.toString(),
+      url: "/api/v3/stock/historical-financial-sheets",
+      params: {
+        symbol,
+        from: formatDate(from),
+        to: formatDate(to),
+        sheetType,
+        periodType: period,
+        currency,
+        region,
+      },
     });
   }
 }