laplace-api 3.1.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laplace-api",
-  "version": "3.1.0",
+  "version": "4.0.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

@@ -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 {
@@ -22,10 +32,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 +42,133 @@ 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
+  ): Promise<PaginatedResponse<Broker>> {
+    return this.sendRequest<PaginatedResponse<Broker>>({
       method: "GET",
-      url: BrokerClient.BASE + "/market",
+      url: BrokerClient.BASE,
       params: {
         region,
-        fromDate,
-        toDate,
-        sortBy,
         page,
         size,
       },
     });
   }
 
-  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: BrokerClient.BASE + "/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: BrokerClient.BASE + "/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: BrokerClient.BASE + "/" + 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: BrokerClient.BASE + "/stock/" + symbol,
       params: {
+        symbol,
         region,
+        sortBy,
+        sortDirection,
         fromDate,
         toDate,
-        sortBy,
-        top,
-        brokerSymbol,
+        page,
+        size,
       },
     });
   }

package/src/client/capital_increase.ts

@@ -1,5 +1,5 @@
 import { Client } from './client';
-import { Region, Locale } from './collections';
+import { Region } from './collections';
 
 // type PaginatedResponse[T any] struct {
 // 	RecordCount int `json:"recordCount"`
@@ -18,23 +18,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;

package/src/client/collections.ts

@@ -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>;
 }
@@ -71,10 +71,6 @@ export class CollectionClient extends Client {
     return this.getAllCollectionsPrivate(CollectionType.Theme, region, locale);
   }
 
-  async getAllCustomThemes(region: Region, locale: Locale): Promise<Collection[]> {
-    return this.getAllCollectionsPrivate(CollectionType.CustomTheme, region, locale);
-  }
-
   async getAllCollections(region: Region, locale: Locale): Promise<Collection[]> {
     return this.getAllCollectionsPrivate(CollectionType.Collection, region, locale);
   }
@@ -91,10 +87,6 @@ export class CollectionClient extends Client {
     return this.getCollectionDetailPrivate(id, CollectionType.Theme, 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.getCollectionDetailPrivate(id, CollectionType.Collection, region, locale);
   }

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,10 +71,13 @@ 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[]> {
+    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',
@@ -91,13 +96,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',

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,7 +39,7 @@ export interface StockHistoricalRatiosData {
 export enum HistoricalRatiosFormat {
   CURRENCY = "currency",
   PERCENTAGE = "percentage",
-  DECIMAL = "decimal"
+  DECIMAL = "decimal",
 }
 
 export enum HistoricalRatiosKey {
@@ -114,15 +119,16 @@ export enum HistoricalRatiosKey {
 }
 
 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,8 +145,6 @@ export interface HistoricalFinancialSheetRow {
   value: number;
   lineCodeId: number;
   indentLevel: number;
-  firstAncestorLineCodeId: number;
-  sectionLineCodeId: number;
 }
 
 export enum FinancialSheetType {
@@ -167,24 +171,36 @@ 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);
-
-    return this.sendRequest<StockSectorFinancialRatioComparison[]>({
-      method: 'GET',
+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<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',
@@ -192,10 +208,15 @@ export class FinancialClient extends Client  {
     });
   }
 
-  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',