laplace-api 3.1.0 → 4.1.0

package/src/client/broker.ts

@@ -1,11 +1,21 @@
+import { PaginatedResponse } from "./capital_increase";
 import { Client } from "./client";
 import { Region } from "./collections";
 import { AssetClass, AssetType } from "./stocks";
 
 export enum BrokerSort {
-  NetBuy = "netBuy",
-  NetSell = "netSell",
-  Volume = "volume",
+  NetAmount = "netAmount",
+  TotalAmount = "totalAmount",
+  TotalVolume = "totalVolume",
+  TotalBuyAmount = "totalBuyAmount",
+  TotalBuyVolume = "totalBuyVolume",
+  TotalSellAmount = "totalSellAmount",
+  TotalSellVolume = "totalSellVolume",
+}
+
+export enum SortDirection {
+  Desc = "desc",
+  Asc = "asc",
 }
 
 export interface Broker {
@@ -14,6 +24,7 @@ export interface Broker {
   name: string;
   longName: string;
   logo: string;
+  supportedAssetClasses?: AssetClass[]
 }
 
 export interface BrokerStock {
@@ -22,10 +33,9 @@ export interface BrokerStock {
   id: string;
   assetType: AssetType;
   assetClass: AssetClass;
-  region: Region;
 }
 
-export interface BaseBrokerStats {
+export interface BrokerStats {
   totalBuyAmount: number;
   totalSellAmount: number;
   netAmount: number;
@@ -33,164 +43,134 @@ export interface BaseBrokerStats {
   totalSellVolume: number;
   totalVolume: number;
   totalAmount: number;
+  averageCost?: number;
 }
 
-export interface BrokerStats extends BaseBrokerStats {
-  broker: Broker;
-}
-
-export interface MarketBrokersResponse {
-  recordCount: number;
-  totalStats: BaseBrokerStats;
-  items: BrokerStats[];
-}
-
-export interface TopBrokersResponse {
-  topStats: BaseBrokerStats;
-  restStats: BaseBrokerStats;
-  topItems: BrokerStats[];
-}
-
-export interface StockBrokerStats extends BaseBrokerStats {
-  averageCost: number;
-  broker: Broker;
-}
-
-export interface StockOverallStats extends BaseBrokerStats {
-  averageCost: number;
-}
-
-export interface StockBrokersResponse {
-  recordCount: number;
-  totalStats: StockOverallStats;
-  items: StockBrokerStats[];
-}
-
-export interface TopStockBrokersResponse {
-  topStats: StockOverallStats;
-  restStats: StockOverallStats;
-  topItems: StockBrokerStats[];
+export interface BrokerItem extends BrokerStats {
+  broker?: Broker;
+  stock?: BrokerStock;
 }
 
-export interface BrokerStockStats extends BaseBrokerStats {
-  stock: BrokerStock;
-}
-
-export interface TopStocksForBrokerResponse {
-  topStats: BaseBrokerStats;
-  restStats: BaseBrokerStats;
-  topItems: BrokerStockStats[];
+export interface BrokerList extends PaginatedResponse<BrokerItem> {
+  totalStats: BrokerStats;
 }
 
 export class BrokerClient extends Client {
-  private static readonly BASE = "/api/v1/brokers";
 
-  async getMarketBrokers(
+  async getBrokers(
     region: Region,
-    fromDate: string,
-    toDate: string,
-    sortBy: BrokerSort,
-    page: number = 0,
-    size: number = 10
-  ): Promise<MarketBrokersResponse> {
-    return this.sendRequest<MarketBrokersResponse>({
+    page: number,
+    size: number,
+    assetClass?: AssetClass
+  ): Promise<PaginatedResponse<Broker>> {
+    return this.sendRequest<PaginatedResponse<Broker>>({
       method: "GET",
-      url: BrokerClient.BASE + "/market",
+      url: "/api/v1/brokers",
       params: {
         region,
-        fromDate,
-        toDate,
-        sortBy,
         page,
         size,
+        assetClass
       },
     });
   }
 
-  async getTopMarketBrokers(
+  async getMarketStocks(
     region: Region,
+    sortBy: BrokerSort,
+    sortDirection: SortDirection,
     fromDate: string,
     toDate: string,
-    sortBy: BrokerSort,
-    top: number = 5
-  ): Promise<TopBrokersResponse> {
-    return this.sendRequest<TopBrokersResponse>({
+    page: number,
+    size: number
+  ): Promise<BrokerList> {
+    return this.sendRequest<BrokerList>({
       method: "GET",
-      url: BrokerClient.BASE + "/market/top",
+      url: "/api/v1/brokers/market/stock",
       params: {
         region,
+        sortBy,
+        sortDirection,
         fromDate,
         toDate,
-        sortBy,
-        top,
+        page,
+        size,
       },
     });
   }
 
-  async getStockBrokers(
+  async getMarketBrokers(
     region: Region,
+    sortBy: BrokerSort,
+    sortDirection: SortDirection,
     fromDate: string,
     toDate: string,
-    sortBy: BrokerSort,
-    symbol: string,
-    page: number = 0,
-    size: number = 10
-  ): Promise<StockBrokersResponse> {
-    return this.sendRequest<StockBrokersResponse>({
+    page: number,
+    size: number
+  ): Promise<BrokerList> {
+    return this.sendRequest<BrokerList>({
       method: "GET",
-      url: BrokerClient.BASE + "/stock",
+      url: "/api/v1/brokers/market",
       params: {
         region,
+        sortBy,
+        sortDirection,
         fromDate,
         toDate,
-        sortBy,
         page,
         size,
-        symbol,
       },
     });
   }
 
-  async getTopStockBrokers(
+  async getBrokersByStock(
+    symbol: string,
     region: Region,
+    sortBy: BrokerSort,
+    sortDirection: SortDirection,
     fromDate: string,
     toDate: string,
-    sortBy: BrokerSort,
-    symbol: string,
-    top: number = 5
-  ): Promise<TopStockBrokersResponse> {
-    return this.sendRequest<TopStockBrokersResponse>({
+    page: number,
+    size: number
+  ): Promise<BrokerList> {
+    return this.sendRequest<BrokerList>({
       method: "GET",
-      url: BrokerClient.BASE + "/stock/top",
+      url: `/api/v1/brokers/${symbol}`,
       params: {
+        symbol,
         region,
+        sortBy,
+        sortDirection,
         fromDate,
         toDate,
-        sortBy,
-        top,
-        symbol,
+        page,
+        size,
       },
     });
   }
 
-  async getTopStocksForBroker(
+  async getStocksByBroker(
+    symbol: string,
     region: Region,
+    sortBy: BrokerSort,
+    sortDirection: SortDirection,
     fromDate: string,
     toDate: string,
-    sortBy: BrokerSort,
-    brokerSymbol: string,
-    top: number = 5
-  ): Promise<TopStocksForBrokerResponse> {
-    return this.sendRequest<TopStocksForBrokerResponse>({
+    page: number,
+    size: number
+  ): Promise<BrokerList> {
+    return this.sendRequest<BrokerList>({
       method: "GET",
-      url: BrokerClient.BASE + "/top",
+      url: `/api/v1/brokers/stock/${symbol}`,
       params: {
+        symbol,
         region,
+        sortBy,
+        sortDirection,
         fromDate,
         toDate,
-        sortBy,
-        top,
-        brokerSymbol,
+        page,
+        size,
       },
     });
   }

package/src/client/capital_increase.ts

@@ -1,10 +1,5 @@
-import { Client } from './client';
-import { Region, Locale } from './collections';
-
-// type PaginatedResponse[T any] struct {
-// 	RecordCount int `json:"recordCount"`
-// 	Items       []T `json:"items"`
-// }
+import { Client } from "./client";
+import { Region } from "./collections";
 
 export interface PaginatedResponse<T> {
   recordCount: number;
@@ -18,23 +13,23 @@ export interface CapitalIncrease {
   currentCapital: string;
   targetCapital: string;
   types: string[];
-  spkApplicationResult: string;
-  spkApplicationDate: string;
-  spkApprovalDate: string;
-  paymentDate: string;
-  registrationDate: string;
+  spkApplicationResult: string | null;
+  spkApplicationDate: string | null;
+  spkApprovalDate: string | null;
+  paymentDate: string | null;
+  registrationDate: string | null;
   specifiedCurrency: string;
   symbol: string;
-  relatedDisclosureIDs: number[];
+  relatedDisclosureIds: number[];
   rightsRate: string;
   rightsPrice: string;
   rightsTotalAmount: string;
-  rightsStartDate: string;
-  rightsEndDate: string;
-  rightsLastSellDate: string;
+  rightsStartDate: string | null;
+  rightsEndDate: string | null;
+  rightsLastSellDate: string | null;
   bonusRate: string;
   bonusTotalAmount: string;
-  bonusStartDate: string;
+  bonusStartDate: string | null;
   bonusDividendRate: string;
   bonusDividendTotalAmount: string;
   externalCapitalIncreaseAmount: string;
@@ -48,8 +43,8 @@ export class CapitalIncreaseClient extends Client {
     region: Region
   ): Promise<PaginatedResponse<CapitalIncrease>> {
     return this.sendRequest<PaginatedResponse<CapitalIncrease>>({
-      method: 'GET',
-      url: '/api/v1/capital-increase/all',
+      method: "GET",
+      url: "/api/v1/capital-increase/all",
       params: { region, page, size },
     });
   }
@@ -58,11 +53,11 @@ export class CapitalIncreaseClient extends Client {
     symbol: string,
     page: number,
     size: number,
-    region: Region,
+    region: Region
   ): Promise<PaginatedResponse<CapitalIncrease>> {
     return this.sendRequest<PaginatedResponse<CapitalIncrease>>({
       method: 'GET',
-      url: '/api/v1/capital-increase/' + symbol,
+      url: `/api/v1/capital-increase/${symbol}`,
       params: { region, page, size },
     });
   }
@@ -74,7 +69,7 @@ export class CapitalIncreaseClient extends Client {
   ): Promise<CapitalIncrease[]> {
     return this.sendRequest<CapitalIncrease[]>({
       method: 'GET',
-      url: '/api/v1/rights/active/' + symbol,
+      url: `/api/v1/rights/active/${symbol}`,
       params: { date, region },
     });
   }

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',
@@ -26,14 +26,14 @@ export enum SortBy {
 export interface Collection {
   id: string;
   title: string;
-  description: string;
-  region: Region[];
-  assetClass: string;
+  description?: string;
+  region?: Region[];
+  assetClass?: string;
   imageUrl: string;
   avatarUrl: string;
   numStocks: number;
-  image: string;
-  order: number;
+  image?: string;
+  order?: number;
   status?: string;
   metaData?: Record<string, any>;
 }
@@ -42,60 +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);
-  }
-
-  async getAllCustomThemes(region: Region, locale: Locale): Promise<Collection[]> {
-    return this.getAllCollectionsPrivate(CollectionType.CustomTheme, 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 getCustomThemeDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
-    return this.getCollectionDetailPrivate(id, CollectionType.CustomTheme, region, locale);
+ 
+  async getCollectionDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
+    return this.sendRequest<CollectionDetail>({
+      method: 'GET',
+      url: `/api/v1/collection/${id}`,
+      params: { region, locale },
+    });
   }
 
-  async getCollectionDetail(id: string, region: Region, locale: Locale): Promise<CollectionDetail> {
-    return this.getCollectionDetailPrivate(id, CollectionType.Collection, 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

@@ -3,37 +3,39 @@ import { Region } from './collections';
 import { AssetClass, AssetType } from './stocks';
 
 export interface StockDividend {
-  date: Date;
-  dividendAmount: number;
-  dividendRatio: number;
-  netDividendAmount: number;
-  netDividendRatio: number;
+  date: string;
+  netAmount: number;
+  netRatio: number;
+  grossAmount: number;
+  grossRatio: number;
   priceThen: number;
+  stoppageRatio: number;
+  stoppageAmount: number;
 }
 
 export interface StockStats {
-  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;
+  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;
-  dayOpen: number;
-  eps: number;
+  latestPrice?: number;
+  dailyChange?: number;
+  dayLow?: number;
+  dayHigh?: number;
+  lowerPriceLimit?: number;
+  upperPriceLimit?: number;
+  dayOpen?: number;
+  eps?: number;
 }
 
 export enum StockStatsKey {
@@ -59,8 +61,8 @@ export enum StockStatsKey {
 export interface TopMover {
   symbol: string;
   change: number;
-  assetClass: AssetClass;
-  assetType: AssetType
+  assetClass?: AssetClass;
+  assetType?: AssetType;
 }
 
 export enum TopMoverDirection {
@@ -69,14 +71,14 @@ export enum TopMoverDirection {
 }
 
 export class FinancialFundamentalsClient extends Client {
-  async getStockDividends(symbol: string, region: Region): Promise<StockDividend[]> {
-    const url = new URL(`${this['baseUrl']}/api/v1/stock/dividends`);
-    url.searchParams.append('symbol', symbol);
-    url.searchParams.append('region', region);
-
+  async getStockDividends(
+    symbol: string,
+    region: Region
+  ): Promise<StockDividend[]> {
     return this.sendRequest<StockDividend[]>({
       method: 'GET',
-      url: url.toString(),
+      url: "/api/v2/stock/dividends",
+      params: { symbol, region }
     });
   }
 
@@ -91,13 +93,16 @@ export class FinancialFundamentalsClient extends Client {
     });
   }
 
-  async getTopMovers(region: Region, page: number, pageSize: number, direction: TopMoverDirection, assetType?: AssetType): Promise<TopMover[]> {
+  async getTopMovers(region: Region, page: number, pageSize: number, direction: TopMoverDirection, 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',