okx-api - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

lib/rest-client.d.ts

@@ -88,4 +88,4 @@ import { AxiosRequestConfig } from 'axios';
     getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>;
-    getBlockTrades(params?: unknown): Promise<unknown[]>;
-    getPublicRFQBlockTrades(params?: unknown): Promise<unknown[]>;
+    getBlockTrades(params?: any): Promise<any[]>;
+    getPublicRFQBlockTrades(params?: any): Promise<any[]>;
     /**
@@ -114,16 +114,16 @@ *
     }): Promise<AssetBillDetails[]>;
-    getLightningDeposits(ccy: string, amt: numberInString, to?: '6' | '18'): Promise<unknown[]>;
-    getDepositAddress(ccy: string): Promise<unknown[]>;
-    getDepositHistory(params?: unknown): Promise<unknown[]>;
+    getLightningDeposits(ccy: string, amt: numberInString, to?: '6' | '18'): Promise<any[]>;
+    getDepositAddress(ccy: string): Promise<any[]>;
+    getDepositHistory(params?: any): Promise<any[]>;
     submitWithdraw(params: WithdrawRequest): Promise<WithdrawResponse[]>;
-    submitWithdrawLightning(ccy: string, invoice: string, memo?: string): Promise<unknown[]>;
-    cancelWithdrawal(wdId: string): Promise<unknown[]>;
-    getWithdrawalHistory(params?: unknown): Promise<unknown[]>;
-    smallAssetsConvert(ccy: string[]): Promise<unknown[]>;
-    getSavingBalance(ccy?: string): Promise<unknown[]>;
-    savingsPurchaseRedemption(ccy: string, amt: numberInString, side: 'purchase' | 'redempt', rate: numberInString): Promise<unknown[]>;
-    setLendingRate(ccy: string, rate: numberInString): Promise<unknown[]>;
-    getLendingHistory(params?: PaginatedSymbolRequest): Promise<unknown[]>;
-    getPublicBorrowInfo(ccy?: string): Promise<unknown[]>;
-    getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<unknown[]>;
+    submitWithdrawLightning(ccy: string, invoice: string, memo?: string): Promise<any[]>;
+    cancelWithdrawal(wdId: string): Promise<any[]>;
+    getWithdrawalHistory(params?: any): Promise<any[]>;
+    smallAssetsConvert(ccy: string[]): Promise<any[]>;
+    getSavingBalance(ccy?: string): Promise<any[]>;
+    savingsPurchaseRedemption(ccy: string, amt: numberInString, side: 'purchase' | 'redempt', rate: numberInString): Promise<any[]>;
+    setLendingRate(ccy: string, rate: numberInString): Promise<any[]>;
+    getLendingHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
+    getPublicBorrowInfo(ccy?: string): Promise<any[]>;
+    getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
     /**
@@ -134,7 +134,7 @@ *
      */
-    getConvertCurrencies(): Promise<unknown[]>;
-    getConvertCurrencyPair(fromCcy: string, toCcy: string): Promise<unknown[]>;
-    estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<unknown[]>;
-    convertTrade(params: ConvertTradeRequest): Promise<unknown[]>;
-    getConvertHistory(params?: unknown): Promise<unknown[]>;
+    getConvertCurrencies(): Promise<any[]>;
+    getConvertCurrencyPair(fromCcy: string, toCcy: string): Promise<any[]>;
+    estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<any[]>;
+    convertTrade(params: ConvertTradeRequest): Promise<any[]>;
+    getConvertHistory(params?: any): Promise<any[]>;
     /**
@@ -150,5 +150,5 @@ *
     /** Up to last 7 days */
-    getBills(params?: unknown): Promise<AccountBill[]>;
+    getBills(params?: any): Promise<AccountBill[]>;
     /** Last 3 months */
-    getBillsArchive(params?: unknown): Promise<AccountBill[]>;
+    getBillsArchive(params?: any): Promise<AccountBill[]>;
     getAccountConfiguration(): Promise<AccountConfiguration[]>;
@@ -177,16 +177,16 @@ setPositionMode(posMode: 'long_short_mode' | 'net'): Promise<AccountPositionModeResult[]>;
     getFeeRates(instType: InstrumentType, instId?: string, uly?: string): Promise<AccountFeeRate[]>;
-    getInterestAccrued(params?: unknown): Promise<unknown[]>;
-    getInterestRate(ccy?: string): Promise<unknown[]>;
-    setGreeksDisplayType(greeksType: 'PA' | 'BS'): Promise<unknown[]>;
+    getInterestAccrued(params?: any): Promise<any[]>;
+    getInterestRate(ccy?: string): Promise<any[]>;
+    setGreeksDisplayType(greeksType: 'PA' | 'BS'): Promise<any[]>;
     setIsolatedMode(isoMode: 'automatic' | 'autonomy', type: 'MARGIN' | 'CONTRACTS'): Promise<AccountIsolatedMode[]>;
-    getMaxWithdrawals(ccy?: string): Promise<unknown[]>;
-    getAccountRiskState(): Promise<unknown[]>;
-    borrowRepayVIPLoan(ccy: string, side: 'borrow' | 'repay', amt: numberInString, ordId?: string): Promise<unknown[]>;
-    getVIPLoanBorrowRepayHistory(params?: unknown): Promise<unknown[]>;
+    getMaxWithdrawals(ccy?: string): Promise<any[]>;
+    getAccountRiskState(): Promise<any[]>;
+    borrowRepayVIPLoan(ccy: string, side: 'borrow' | 'repay', amt: numberInString, ordId?: string): Promise<any[]>;
+    getVIPLoanBorrowRepayHistory(params?: any): Promise<any[]>;
     getBorrowInterestLimits(params?: {
         type?: '1' | '2';
         ccy?: string;
-    }): Promise<unknown[]>;
-    positionBuilder(params?: unknown): Promise<unknown[]>;
-    getGreeks(ccy?: string): Promise<unknown[]>;
+    }): Promise<any[]>;
+    positionBuilder(params?: any): Promise<any[]>;
+    getGreeks(ccy?: string): Promise<any[]>;
     getPMLimitation(params: {
@@ -196,3 +196,3 @@ instType: 'SWAP' | 'FUTURES' | 'OPTION';
         instFamily?: string;
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     /**
@@ -204,3 +204,3 @@ *
     /** View sub-account list */
-    getSubAccountList(params?: unknown): Promise<SubAccount[]>;
+    getSubAccountList(params?: any): Promise<SubAccount[]>;
     /** Reset the APIKey of a sub-account */
@@ -224,9 +224,9 @@ resetSubAccountAPIKey(subAcct: string, apiKey: string, options?: {
         limit?: string;
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     /** Master accounts manage the transfers between sub-accounts */
     transferSubAccountBalance(params: SubAccountTransferRequest): Promise<SubAccountTransferResult[]>;
     /** Set Permission Of Transfer Out */
-    setSubAccountTransferOutPermission(subAcct: string, canTransOut?: boolean): Promise<unknown[]>;
+    setSubAccountTransferOutPermission(subAcct: string, canTransOut?: boolean): Promise<any[]>;
     /** Get custody trading sub-account list */
-    getSubAccountCustodyTradingList(subAcct?: string): Promise<unknown[]>;
+    getSubAccountCustodyTradingList(subAcct?: string): Promise<any[]>;
     /**
@@ -237,11 +237,11 @@ *
      */
-    placeGridAlgoOrder(params: GridAlgoOrderRequest): Promise<unknown[]>;
+    placeGridAlgoOrder(params: GridAlgoOrderRequest): Promise<any[]>;
     amendGridAlgoOrder(algoId: string, instId: string, triggerPx: {
         slTriggerPx?: numberInString;
         tpTriggerPx?: numberInString;
-    }): Promise<unknown[]>;
-    stopGridAlgoOrder(orders: StopGridAlgoOrderRequest[]): Promise<unknown[]>;
-    getGridAlgoOrderList(params: GetGridAlgoOrdersRequest): Promise<unknown[]>;
-    getGridAlgoOrderHistory(params: GetGridAlgoOrdersRequest): Promise<unknown[]>;
-    getGridAlgoOrderDetails(algoOrdType: GridAlgoOrderType, algoId: string): Promise<unknown[]>;
+    }): Promise<any[]>;
+    stopGridAlgoOrder(orders: StopGridAlgoOrderRequest[]): Promise<any[]>;
+    getGridAlgoOrderList(params: GetGridAlgoOrdersRequest): Promise<any[]>;
+    getGridAlgoOrderHistory(params: GetGridAlgoOrdersRequest): Promise<any[]>;
+    getGridAlgoOrderDetails(algoOrdType: GridAlgoOrderType, algoId: string): Promise<any[]>;
     getGridAlgoSubOrders(algoOrdType: GridAlgoOrderType, algoId: string, type: GridAlgoSubOrderType, groupId?: string, pagination?: {
@@ -251,12 +251,12 @@ after?: numberInString;
         limit?: number;
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     /** Only contract grid supports this method */
-    getGridAlgoOrderPositions(algoOrdType: 'contract_grid', algoId: string): Promise<unknown[]>;
-    spotGridWithdrawIncome(algoId: string): Promise<unknown[]>;
-    computeGridMarginBalance(algoId: string, type: 'add' | 'reduce', amt?: numberInString): Promise<unknown[]>;
+    getGridAlgoOrderPositions(algoOrdType: 'contract_grid', algoId: string): Promise<any[]>;
+    spotGridWithdrawIncome(algoId: string): Promise<any[]>;
+    computeGridMarginBalance(algoId: string, type: 'add' | 'reduce', amt?: numberInString): Promise<any[]>;
     adjustGridMarginBalance(algoId: string, type: 'add' | 'reduce', change: {
         amt?: numberInString;
         percent?: numberInString;
-    }): Promise<unknown[]>;
-    getGridAIParameter(algoOrdType: GridAlgoOrderType, instId: string, direction: ContractGridDirection, duration?: '7D' | '30D' | '180D'): Promise<unknown[]>;
+    }): Promise<any[]>;
+    getGridAIParameter(algoOrdType: GridAlgoOrderType, instId: string, direction: ContractGridDirection, duration?: '7D' | '30D' | '180D'): Promise<any[]>;
     /**
@@ -323,9 +323,9 @@ *
     }): Promise<Trade[]>;
-    get24hrTotalVolume(): Promise<unknown[]>;
-    getOracle(): Promise<unknown[]>;
-    getExchangeRate(): Promise<unknown[]>;
-    getIndexComponents(index: string): Promise<unknown[]>;
-    getBlockTickers(instType: InstrumentType, uly?: string): Promise<unknown[]>;
-    getBlockTicker(instId: string): Promise<unknown[]>;
-    getPublicBlockTrades(instId: string): Promise<unknown[]>;
+    get24hrTotalVolume(): Promise<any[]>;
+    getOracle(): Promise<any[]>;
+    getExchangeRate(): Promise<any[]>;
+    getIndexComponents(index: string): Promise<any[]>;
+    getBlockTickers(instType: InstrumentType, uly?: string): Promise<any[]>;
+    getBlockTicker(instId: string): Promise<any[]>;
+    getPublicBlockTrades(instId: string): Promise<any[]>;
     /**
@@ -337,19 +337,19 @@ *
     getInstruments(instType: InstrumentType, uly?: string, instFamily?: string, instId?: string): Promise<Instrument[]>;
-    getDeliveryExerciseHistory(params: unknown): Promise<unknown[]>;
-    getOpenInterest(params: unknown): Promise<unknown[]>;
-    getFundingRate(params: unknown): Promise<unknown[]>;
-    getFundingRateHistory(params: unknown): Promise<unknown[]>;
-    getMinMaxLimitPrice(params: unknown): Promise<unknown[]>;
-    getOptionMarketData(params: unknown): Promise<unknown[]>;
-    getEstimatedDeliveryExercisePrice(params: unknown): Promise<unknown[]>;
-    getDiscountRateAndInterestFreeQuota(params: unknown): Promise<unknown[]>;
-    getSystemTime(params: unknown): Promise<unknown[]>;
-    getLiquidationOrders(params: unknown): Promise<unknown[]>;
-    getMarkPrice(params: unknown): Promise<unknown[]>;
-    getPositionTiers(params: unknown): Promise<unknown[]>;
-    getInterestRateAndLoanQuota(params: unknown): Promise<unknown[]>;
-    getVIPInterestRateAndLoanQuota(params: unknown): Promise<unknown[]>;
-    getUnderlying(params: unknown): Promise<unknown[]>;
-    getInsuranceFund(params: unknown): Promise<unknown[]>;
-    getUnitConvert(params: unknown): Promise<unknown[]>;
+    getDeliveryExerciseHistory(params: any): Promise<any[]>;
+    getOpenInterest(params: any): Promise<any[]>;
+    getFundingRate(params: any): Promise<any[]>;
+    getFundingRateHistory(params: any): Promise<any[]>;
+    getMinMaxLimitPrice(params: any): Promise<any[]>;
+    getOptionMarketData(params: any): Promise<any[]>;
+    getEstimatedDeliveryExercisePrice(params: any): Promise<any[]>;
+    getDiscountRateAndInterestFreeQuota(params: any): Promise<any[]>;
+    getSystemTime(params: any): Promise<any[]>;
+    getLiquidationOrders(params: any): Promise<any[]>;
+    getMarkPrice(params: any): Promise<any[]>;
+    getPositionTiers(params: any): Promise<any[]>;
+    getInterestRateAndLoanQuota(params: any): Promise<any[]>;
+    getVIPInterestRateAndLoanQuota(params: any): Promise<any[]>;
+    getUnderlying(params: any): Promise<any[]>;
+    getInsuranceFund(params: any): Promise<any[]>;
+    getUnitConvert(params: any): Promise<any[]>;
     /**
@@ -360,4 +360,4 @@ *
      */
-    getSupportCoin(): Promise<unknown[]>;
-    getTakerVolume(): Promise<unknown[]>;
+    getSupportCoin(): Promise<any[]>;
+    getTakerVolume(): Promise<any[]>;
     getMarginLendingRatio(params: {
@@ -368,3 +368,3 @@ ccy: string;
         period: '5m' | '1H' | '1D';
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     getLongShortRatio(params: {
@@ -375,3 +375,3 @@ ccy: string;
         period: '5m' | '1H' | '1D';
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     getContractsOpenInterestAndVolume(params: {
@@ -382,15 +382,15 @@ ccy: string;
         period: '5m' | '1H' | '1D';
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     getOptionsOpenInterestAndVolume(params: {
         ccy: string;
         period: '8H' | '1D';
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     getPutCallRatio(params: {
         ccy: string;
         period: '8H' | '1D';
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     getOpenInterestAndVolumeExpiry(params: {
         ccy: string;
         period: '8H' | '1D';
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     getOpenInterestAndVolumeStrike(params: {
@@ -400,7 +400,7 @@ ccy: string;
         period: '8H' | '1D';
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     getTakerFlow(params: {
         ccy: string;
         period: '8H' | '1D';
-    }): Promise<unknown[]>;
+    }): Promise<any[]>;
     /**
@@ -411,3 +411,3 @@ *
      */
-    getSystemStatus(state?: 'scheduled' | 'ongoing' | 'pre_open' | 'completed' | 'canceled'): Promise<unknown[]>;
+    getSystemStatus(state?: 'scheduled' | 'ongoing' | 'pre_open' | 'completed' | 'canceled'): Promise<any[]>;
     /**
@@ -418,3 +418,3 @@ *
      */
-    getBrokerAccountInformation(): Promise<unknown[]>;
+    getBrokerAccountInformation(): Promise<any[]>;
 }

lib/types/websockets/request.d.ts

@@ -21,3 +21,3 @@ export interface WsAuthRequestArg {
     op: WsRequestOp;
-    args: unknown[];
+    args: any[];
 }
@@ -28,3 +28,3 @@ /** Used to trigger order actions over websockets (e.g. placing & cancelling orders) */
     id: string;
-    args: unknown[];
+    args: any[];
 }
@@ -31,0 +31,0 @@ export interface WsBaseRequestArg {

package.json

 {
   "name": "okx-api",
-  "version": "1.1.2",
-  "description": "Complete & robust Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests.",
+  "version": "1.1.3",
+  "description": "Complete & robust Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests",
   "main": "lib/index.js",
@@ -6,0 +6,0 @@ "types": "lib/index.d.ts",

No alert changes

Worsened metrics

Total package byte prevSize

243818

decreased by-0.19%

No dependency changes