okx-api 1.1.3 → 1.1.4

package/lib/types/rest/request/account.d.ts

@@ -1,14 +1,14 @@
-import { InstrumentType } from '../shared';
+import { InstrumentType, MarginMode, PositionSide } from '../shared';
 export interface SetLeverageRequest {
     instId?: string;
     ccy?: string;
     lever: string;
-    mgnMode: 'isolated' | 'cross';
+    mgnMode: MarginMode;
     posSide?: 'long' | 'short';
 }
 export interface ChangePositionMarginRequest {
     instId: string;
-    posSide: 'long' | 'short' | 'net';
+    posSide: PositionSide;
     type: 'add' | 'reduce';
     amt: string;
     ccy?: string;

package/lib/types/rest/request/trade.d.ts

@@ -2,7 +2,7 @@ import { TradeMode, OrderSide, PositionSide, AlgoOrderType, numberInString, Pric
 export interface AlgoRecentHistoryRequest {
     ordType: AlgoOrderType;
     algoId?: string;
-    instType?: string;
+    instType?: InstrumentType;
     instId?: string;
     after?: string;
     before?: string;
@@ -12,7 +12,7 @@ export interface AlgoLongHistoryRequest {
     ordType: AlgoOrderType;
     state?: AlgoState;
     algoId?: string;
-    instType?: string;
+    instType?: InstrumentType;
     instId?: string;
     after?: string;
     before?: string;
@@ -23,7 +23,7 @@ export interface AlgoOrderRequest {
     tdMode: TradeMode;
     ccy?: string;
     side: OrderSide;
-    posSide?: PositionSide;
+    posSide?: Omit<PositionSide, 'net'>;
     ordType: AlgoOrderType;
     sz: numberInString;
     tag?: string;

package/lib/types/rest/response/private-account.d.ts

@@ -1,3 +1,4 @@
+import { MarginMode, PositionSide } from "../shared";
 export interface AccountBalance {
     adjEq: string;
     details: AccountBalanceDetail[];
@@ -57,7 +58,7 @@ export interface AccountPosition {
     liqPx: string;
     markPx: string;
     margin: string;
-    mgnMode: string;
+    mgnMode: MarginMode;
     mgnRatio: string;
     mmr: string;
     notionalUsd: string;
@@ -66,7 +67,7 @@ export interface AccountPosition {
     pos: string;
     posCcy: string;
     posId: string;
-    posSide: string;
+    posSide: PositionSide;
     thetaBS: string;
     thetaPA: string;
     tradeId: string;
@@ -84,13 +85,13 @@ export interface HistoricAccountPosition {
     instId: string;
     instType: string;
     lever: string;
-    mgnMode: string;
+    mgnMode: MarginMode;
     openAvgPx: string;
     openMaxPos: string;
     pnl: string;
     pnlRatio: string;
     posId: string;
-    posSide: string;
+    posSide: PositionSide;
     triggerPx: string;
     type: string;
     uTime: string;
@@ -106,13 +107,13 @@ export interface AccountPositionRiskData {
     ccy: string;
     instId: string;
     instType: string;
-    mgnMode: string;
+    mgnMode: MarginMode;
     notionalCcy: string;
     notionalUsd: string;
     pos: string;
     posCcy: string;
     posId: string;
-    posSide: string;
+    posSide: PositionSide;
     quoteBal: string;
 }
 export interface AccountPositionRisk {
@@ -131,7 +132,7 @@ export interface AccountBill {
     from: string;
     instId: string;
     instType: string;
-    mgnMode: string;
+    mgnMode: MarginMode;
     notes: string;
     ordId: string;
     pnl: string;
@@ -152,16 +153,27 @@ export interface AccountConfiguration {
     levelTmp: string;
     mgnIsoMode: string;
     posMode: string;
+    spotOffsetType: string;
     uid: string;
+    label: string;
+    roleType: string;
+    traderInsts: any[];
+    spotRoleType: string;
+    spotTraderInsts: any[];
+    opAuth: string;
+    kycLv: string;
+    ip: string;
+    perm: string;
+    mainUid: string;
 }
 export interface AccountPositionModeResult {
     posMode: string;
 }
 export interface AccountLeverageResult {
     lever: string;
-    mgnMode: string;
+    mgnMode: MarginMode;
     instId: string;
-    posSide: string;
+    posSide: PositionSide;
 }
 export interface AccountMaxOrderAmount {
     ccy: string;
@@ -179,18 +191,18 @@ export interface AccountChangeMarginResult {
     ccy: string;
     instId: string;
     leverage: string;
-    posSide: string;
+    posSide: PositionSide;
     type: string;
 }
 export interface AccountLeverage {
     instId: string;
-    mgnMode: string;
-    posSide: string;
+    mgnMode: MarginMode;
+    posSide: PositionSide;
     lever: string;
 }
 export interface AccountMaxLoan {
     instId: string;
-    mgnMode: string;
+    mgnMode: MarginMode;
     mgnCcy: string;
     maxLoan: string;
     ccy: string;

package/lib/types/rest/response/private-trade.d.ts

@@ -1,4 +1,4 @@
-import { numberInString } from '../shared';
+import { PositionSide, numberInString } from '../shared';
 export interface OrderResult {
     clOrdId: string;
     ordId: string;
@@ -21,7 +21,7 @@ export interface AmendedOrder {
 }
 export interface ClosedPositions {
     instId: string;
-    posSide: string;
+    posSide: PositionSide;
 }
 export interface OrderDetails {
     instType: string;
@@ -35,7 +35,7 @@ export interface OrderDetails {
     pnl: string;
     ordType: string;
     side: string;
-    posSide: string;
+    posSide: PositionSide;
     tdMode: string;
     accFillSz: string;
     fillPx: string;
@@ -78,7 +78,7 @@ export interface OrderListItem {
     ordId: string;
     ordType: string;
     pnl: string;
-    posSide: string;
+    posSide: PositionSide;
     px: string;
     rebate: string;
     rebateCcy: string;
@@ -109,7 +109,7 @@ export interface HistoricOrder {
     sz: string;
     ordType: string;
     side: string;
-    posSide: string;
+    posSide: PositionSide;
     tdMode: string;
     accFillSz: string;
     fillPx: string;
@@ -147,7 +147,7 @@ export interface OrderFill {
     fillPx: string;
     fillSz: string;
     side: string;
-    posSide: string;
+    posSide: PositionSide;
     execType: string;
     feeCcy: string;
     fee: string;
@@ -167,7 +167,7 @@ export interface AlgoOrderListItem {
     sz: string;
     ordType: string;
     side: string;
-    posSide: string;
+    posSide: PositionSide;
     tdMode: string;
     tgtCcy: string;
     state: string;
@@ -205,7 +205,7 @@ export interface HistoricAlgoOrder {
     sz: string;
     ordType: string;
     side: string;
-    posSide: string;
+    posSide: PositionSide;
     tdMode: string;
     tgtCcy: string;
     state: string;

package/lib/types/websockets/event.d.ts

@@ -6,14 +6,14 @@ export interface WsEvent {
     arg?: any;
     data?: any;
 }
-export interface WsDataEvent {
+export interface WsDataEvent<T = any> {
     arg: {
         channel: WsChannel;
         uid?: string;
         instId?: string;
         instFamily?: string;
     };
-    data: any;
+    data: T;
 }
 export interface WsLoginEvent extends WsEvent {
     event: 'login';

package/package.json

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