laplace-api 4.8.0 → 5.1.0

package/src/client/funds.ts

@@ -101,15 +101,20 @@ export interface FundHistoricalPrice {
 }
 
 export class FundsClient extends Client {
-  async getFunds(region: Region, page: number, pageSize: number) {
+  async getFunds(region: Region, pageSize?: number, page?: number): Promise<Fund[]> {
+    const params = {
+      region,
+      ...(pageSize != null && { pageSize }),
+      ...(page != null && { page })
+    }
     return this.sendRequest<Fund[]>({
       method: "GET",
       url: `/api/v1/fund`,
-      params: { region, page, pageSize },
+      params: params,
     });
   }
 
-  async getFundStats(symbol: string, region: Region) {
+  async getFundStats(symbol: string, region: Region): Promise<FundStats> {
     return this.sendRequest<FundStats>({
       method: "GET",
       url: `/api/v1/fund/stats`,
@@ -117,7 +122,7 @@ export class FundsClient extends Client {
     });
   }
 
-  async getFundDistribution(symbol: string, region: Region) {
+  async getFundDistribution(symbol: string, region: Region): Promise<FundDistribution> {
     return this.sendRequest<FundDistribution>({
       method: "GET",
       url: `/api/v1/fund/distribution`,
@@ -129,7 +134,7 @@ export class FundsClient extends Client {
     symbol: string,
     region: Region,
     period: HistoricalFundPricePeriod
-  ) {
+  ): Promise<FundHistoricalPrice[]> {
     return this.sendRequest<FundHistoricalPrice[]>({
       method: "GET",
       url: `/api/v1/fund/price`,

package/src/client/key-insights.ts

@@ -10,7 +10,7 @@ export class KeyInsightClient extends Client {
   async getKeyInsights(symbol: string, region: Region) {
     return this.sendRequest<KeyInsight>({
       method: "GET",
-      url: "/api/v1/key-insight",
+      url: "/api/v1/key-insights",
       params: { symbol, region },
     });
   }

package/src/client/live-price-web-socket.ts

@@ -34,8 +34,10 @@ export enum LivePriceFeed {
   LiveBist = "live_price_tr",
   LiveUs = "live_price_us",
   DelayedBist = "delayed_price_tr",
-  DelayedUs = "delayed_price_us",
   DepthBist = "depth_tr",
+  Custom = "custom",
+  StateUs = "state_us",
+  LiveAskBidBist = "live_ask_bid_price_tr",
 }
 
 type StockLiveDataType<T extends LivePriceFeed> = T extends

package/src/client/live-price.ts

@@ -21,6 +21,8 @@ export interface BISTStockPriceData {
 export interface USStockPriceData {
   s: string; // Symbol
   p: number; // Price
+  pc: number; // PercentChange
+  ac: number; // AmountChange
   d: number; // Date
 }
 
@@ -42,7 +44,7 @@ export interface OrderbookLevel {
 }
 
 export interface BISTBidAskData {
-  d: string;
+  d: number;
   s: string;
   ask: number;
   bid: number;
@@ -76,26 +78,6 @@ interface WebSocketUsageResponse {
   uniqueDeviceCount: number;
 }
 
-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;
-}
-
 export interface SendWebsocketEventRequest {
   externalUserID?: string;
   event: Record<string, any>;
@@ -323,49 +305,41 @@ export class LivePriceClient extends Client {
     externalUserId: string,
     feeds: LivePriceFeed[]
   ): Promise<string> {
-    const url = new URL(`${this["baseUrl"]}/api/v2/ws/url`);
-
-    const params: WebSocketUrlParams = {
-      externalUserId,
-      feeds
-    };
-
     const response = await this.sendRequest<WebSocketUrlResponse>({
       method: "POST",
-      url: url.toString(),
-      data: params,
+      url: "/api/v2/ws/url",
+      data: { externalUserId, feeds },
     });
 
     return response.url;
   }
 
   async getWebsocketUsageForMonth(
-    month: string,
-    year: string,
+    month: number,
+    year: number,
     feedType: LivePriceFeed,
   ): Promise<WebSocketUsageResponse[]> {
-    const url = new URL(`${this["baseUrl"]}/api/v1/ws/report`);
-    url.searchParams.append("month", month);
-    url.searchParams.append("year", year);
-    url.searchParams.append("feedType", feedType);
-
-    const response = await this.sendRequest<WebSocketUsageResponse[]>({
+    return this.sendRequest<WebSocketUsageResponse[]>({
       method: "GET",
-      url: url.toString(),
+      url: "/api/v1/ws/report",
+      params: { month, year, feedType },
     });
-
-    return response;
   }
 
   async sendWebsocketEvent(
     request: SendWebsocketEventRequest
   ): Promise<void> {
-    const url = new URL(`${this["baseUrl"]}/api/v1/ws/event`);
-
     await this.sendRequest<void>({
       method: "POST",
-      url: url.toString(),
+      url: "/api/v1/ws/event",
       data: request,
     });
   }
+
+  async revokeWebsocketConnection(id: string): Promise<void> {
+    await this.sendRequest<void>({
+      method: "POST",
+      url: `/api/v1/ws/user/revoke/${id}`,
+    });
+  }
 }

package/src/client/news.ts

@@ -42,7 +42,7 @@ export interface News {
 
 export interface NewsPublisher {
     name: string;
-    logoUrl?: string;
+    logoUrl: string | null;
 }
 
 export interface NewsTicker {
@@ -54,15 +54,15 @@ export interface NewsTicker {
 export interface NewsCategories {
     name: string;
     newsCount: number;
-    categoryType?: string;
-    meanType?: number;
+    categoryType?: string | null;
+    meanType?: number | null;
 }
 
 export interface NewsSector {
     name: string;
     newsCount: number;
-    categoryType?: string;
-    meanType?: number;
+    categoryType?: string | null;
+    meanType?: number | null;
 }
 
 export interface NewsContent {
@@ -79,62 +79,46 @@ export interface NewsIndustry {
 }
 
 export class NewsClient extends Client {
-    async getHighlights(region: Region, locale: Locale): Promise<NewsHighlights> {
-        const url = new URL(
-            `${this["baseUrl"]}/api/v1/news/highlights`,
-        );
-        url.searchParams.append("region", region);
-        url.searchParams.append("locale", locale);
-
+    async getHighlights(
+        region: Region,
+        locale: Locale
+      ): Promise<NewsHighlights> {
         return this.sendRequest<NewsHighlights>({
-            method: "GET",
-            url: url.toString(),
-        })
-    }
+          method: "GET",
+          url: "/api/v1/news/highlights",
+          params: {
+            region,
+            locale,
+          },
+        });
+      }
+      
 
     async getNews(
         region: Region,
         locale: Locale,
-        newsType: NewsType | null,
-        page: number | null,
-        size: number | null,
-        orderBy: NewsOrderBy | null,
-        orderByDirection: SortDirection | null,
-        extraFilters: string | null,
-    ): Promise<PaginatedResponse<News>> {
-        const url = new URL(
-            `${this["baseUrl"]}/api/v1/news`,
-        );
-        url.searchParams.append("region", region);
-        url.searchParams.append("locale", locale);
-
-        if (newsType) {
-            url.searchParams.append("newsType", newsType);
-        }
-
-        if (page) {
-            url.searchParams.append("page", page.toString());
-        }
-
-        if (size) {
-            url.searchParams.append("size", size.toString());
-        }
-
-        if (orderBy) {
-            url.searchParams.append("orderBy", orderBy);
-        }
-
-        if (orderByDirection) {
-            url.searchParams.append("orderByDirection", orderByDirection);
-        }
-
-        if (extraFilters) {
-            url.searchParams.append("extraFilters", extraFilters);
-        }
-
+        newsType?: NewsType,
+        page?: number,
+        size?: number,
+        orderBy?: NewsOrderBy,
+        orderByDirection?: SortDirection,
+        extraFilters?: string
+      ): Promise<PaginatedResponse<News>> {
+        const params = {
+          region,
+          locale,
+          ...(newsType != null && { newsType }),
+          ...(page != null && { page }),
+          ...(size != null && { size }),
+          ...(orderBy != null && { orderBy }),
+          ...(orderByDirection != null && { orderByDirection }),
+          ...(extraFilters != null && { extraFilters }),
+        };
+      
         return this.sendRequest<PaginatedResponse<News>>({
-            method: "GET",
-            url: url.toString(),
+          method: "GET",
+          url: "/api/v1/news",
+          params,
         });
-    }
+      }      
 }

package/src/client/search.ts

@@ -12,7 +12,7 @@ export interface SearchResponseStock {
   id: string;
   name: string;
   title: string;
-  region: string;
+  region: Region;
   assetType: string;
   type: string;
 }
@@ -20,7 +20,7 @@ export interface SearchResponseStock {
 export interface SearchResponseCollection {
   id: string;
   title: string;
-  region: string[];
+  region: Region[];
   assetClass: string;
   imageUrl: string;
   avatarUrl: string;
@@ -34,18 +34,22 @@ export interface SearchResponse {
 }
 
 export class SearchClient extends Client {
-  async search(query: string, types: SearchType[], region: Region, locale: Locale): Promise<SearchResponse> {
+  async search(query: string, types: SearchType[], locale: Locale, region?: Region, page?: number, size?: number): Promise<SearchResponse> {
     const typesStr = types.join(',');
 
+    const params = {
+      filter: query,
+      types: typesStr,
+      locale,
+      ...(region != null && { region }),
+      ...(page != null && { page }),
+      ...(size != null && { size })
+    }
+
     return this.sendRequest<SearchResponse>({
       method: 'GET',
       url: '/api/v1/search',
-      params: {
-        filter: query,
-        types: typesStr,
-        region,
-        locale,
-      },
+      params: params,
     });
   }
 }

package/src/client/stocks.ts

@@ -13,8 +13,10 @@ export enum AssetType {
 }
 
 export enum AssetClass {
+  Adr = 'adr',
   Equity = 'equity',
   Crypto = 'crypto',
+  Etn = 'etn',
 }
 
 export enum HistoricalPricePeriod {
@@ -81,10 +83,16 @@ export enum Market {
 
 export interface PriceDataPoint {
   d: number;
-  c: number;
+  o: number;
+  uo?: number;
   h: number;
+  uh?: number;
   l: number;
-  o: number;
+  ul?: number;
+  c: number;
+  uc?: number;
+  v?: number;
+  uv?: number;
 }
 
 export interface StockPriceGraph {
@@ -114,7 +122,7 @@ export interface TickRule {
   additionalPrice: number;
   lowerPriceLimit: number;
   upperPriceLimit: number;
-  rules: TickSizeRule[] | null;
+  rules: TickSizeRule[];
 }
 
 export interface TickSizeRule {
@@ -149,9 +157,22 @@ export interface MarketState {
 	stockSymbol?: string | null;
 }
 
+export enum ChartImagePeriod {
+  OneDay = '1D',
+  OneWeek = '1W',
+  OneMonth = '1M',
+  ThreeMonth = '3M',
+  SixMonth = '6M',
+  OneYear = '1Y',
+  TwoYear = '2Y',
+  ThreeYear = '3Y',
+  FiveYear = '5Y',
+  All = 'All',
+}
+
 export interface GenerateChartImageRequest {
   symbol: string;
-  period?: HistoricalPricePeriod;
+  period?: ChartImagePeriod;
   region: Region;
   resolution?: HistoricalPriceInterval;
   indicators?: string[];
@@ -159,14 +180,14 @@ export interface GenerateChartImageRequest {
 }
 
 export class StockClient extends Client {
-  async getAllStocks(region: Region, page: number|null = null, pageSize: number|null = null): Promise<Stock[]> {
+  async getAllStocks(region: Region, page?: number, pageSize?: number): Promise<Stock[]> {
     return this.sendRequest<Stock[]>({
       method: 'GET',
       url: '/api/v2/stock/all',
       params: { 
         region, 
-        ...(page !== null ? { page } : {}),
-        ...(pageSize !== null ? { pageSize } : {}),
+        ...(page != null ? { page } : {}),
+        ...(pageSize != null ? { pageSize } : {}),
       },
     });
   }
@@ -199,14 +220,24 @@ export class StockClient extends Client {
     });
   }
 
-  async getCustomHistoricalPrices(stock: string, region: Region, fromDate: string, toDate: string, interval: HistoricalPriceInterval, detail: boolean): Promise<PriceDataPoint[]> {
+  async getCustomHistoricalPrices(stock: string, region: Region, fromDate: string, toDate: string, interval: HistoricalPriceInterval, detail?: boolean, numIntervals?: number): Promise<PriceDataPoint[]> {
     this.validateCustomHistoricalPriceDate(fromDate);
     this.validateCustomHistoricalPriceDate(toDate);
 
+    const params = {
+      stock,
+      region,
+      fromDate,
+      toDate,
+      interval,
+      ...(detail != null && { detail }),
+      ...(numIntervals != null && { numIntervals })
+    }
+
     return this.sendRequest<PriceDataPoint[]>({
       method: 'GET',
       url: '/api/v1/stock/price/interval',
-      params: { stock, region, fromDate, toDate, interval, detail },
+      params: params,
     });
   }
 
@@ -226,11 +257,10 @@ export class StockClient extends Client {
     });
   }
 
-  async getAllStockRestrictions(region: Region): Promise<StockRestriction[]> {
+  async getAllStockRestrictions(): Promise<StockRestriction[]> {
     return this.sendRequest<StockRestriction[]>({
       method: 'GET',
-      url: '/api/v1/stock/restrictions/all',
-      params: { region },
+      url: '/api/v1/stock/restrictions/all'
     });
   }