okx-api 1.3.6 → 1.4.0

package/lib/types/rest/response/private-spread-trading.d.ts

@@ -0,0 +1,125 @@
+export interface PlaceSpreadOrderResponse {
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface CancelSpreadOrderResponse {
+    ordId: string;
+    clOrdId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface UpdateSpreadOrderResponse {
+    ordId: string;
+    clOrdId: string;
+    reqId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface SpreadOrder {
+    instId: string;
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    px: string;
+    sz: string;
+    ordType: 'limit' | 'post_only' | 'ioc';
+    side: 'buy' | 'sell';
+    fillSz: string;
+    fillPx: string;
+    tradeId: string;
+    accFillSz: string;
+    pendingFillSz: string;
+    pendingSettleSz: string;
+    canceledSz: string;
+    avgPx: string;
+    state: 'canceled' | 'live' | 'partially_filled' | 'filled';
+    cancelSource: string;
+    uTime: string;
+    cTime: string;
+}
+export interface SpreadTradeLeg {
+    instId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    fee: string;
+    feeCcy: string;
+    tradeId: string;
+}
+export interface SpreadTrade {
+    sprdId: string;
+    tradeId: string;
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    fillPx: string;
+    fillSz: string;
+    side: 'buy' | 'sell';
+    state: 'filled' | 'rejected';
+    execType: 'T' | 'M';
+    ts: string;
+    legs: SpreadTradeLeg[];
+}
+export interface SpreadLeg {
+    instId: string;
+    side: 'buy' | 'sell';
+}
+export interface SpreadDetails {
+    sprdId: string;
+    sprdType: 'linear' | 'inverse' | 'hybrid';
+    state: 'live' | 'expired' | 'suspend';
+    baseCcy: string;
+    szCcy: string;
+    quoteCcy: string;
+    tickSz: string;
+    minSz: string;
+    lotSz: string;
+    listTime: string;
+    expTime: string;
+    uTime: string;
+    legs: SpreadLeg[];
+}
+export interface OrderBookEntry {
+    price: string;
+    quantity: string;
+    orderCount: string;
+}
+export interface SpreadOrderBook {
+    asks: OrderBookEntry[];
+    bids: OrderBookEntry[];
+    ts: string;
+}
+export interface SpreadTicker {
+    sprdId: string;
+    last: string;
+    lastSz: string;
+    askPx: string;
+    askSz: string;
+    bidPx: string;
+    bidSz: string;
+    open24h: string;
+    high24h: string;
+    low24h: string;
+    vol24h: string;
+    ts: string;
+}
+export interface PublicSpreadTrade {
+    sprdId: string;
+    tradeId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    ts: string;
+}
+export interface SpreadCandle {
+    ts: string;
+    o: string;
+    h: string;
+    l: string;
+    c: string;
+    vol: string;
+    confirm: string;
+}

package/lib/types/rest/response/private-spread-trading.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=private-spread-trading.js.map

package/lib/types/rest/response/private-spread-trading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-spread-trading.js","sourceRoot":"","sources":["../../../../src/types/rest/response/private-spread-trading.ts"],"names":[],"mappings":""}

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

@@ -54,3 +54,19 @@ export interface SubAccountBalances {
 export interface SubAccountTransferResult {
     transId: string;
 }
+export interface SubAccountMaxWithdrawal {
+    ccy: string;
+    maxWd: string;
+    maxWdEx: string;
+    spotOffsetMaxWd: string;
+    spotOffsetMaxWdEx: string;
+}
+export interface ManagedSubAccountTransfer {
+    billId: string;
+    ccy: string;
+    amt: string;
+    type: string;
+    subAcct: string;
+    subUid: string;
+    ts: string;
+}

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

@@ -332,3 +332,8 @@ export interface HistoricAlgoOrder {
     triggerTime: string;
     amendPxOnTriggerType: string;
 }
+export interface CancelAllAfterResponse {
+    triggerTime: string;
+    tag: string;
+    ts: string;
+}

package/lib/types/rest/response/public-data.d.ts

@@ -136,4 +136,31 @@ export interface FundingRateHistory {
 export interface SystemTime {
     ts: string;
 }
+export interface OptionsTradeInfo {
+    instId: string;
+    tradeId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    ts: string;
+}
+export interface OptionTrade {
+    vol24h: string;
+    optType: 'C' | 'P';
+    tradeInfo: OptionsTradeInfo[];
+}
+export interface OptionTrades {
+    instId: string;
+    instFamily: string;
+    tradeId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    optType: 'C' | 'P';
+    fillVol: string;
+    fwdPx: string;
+    idxPx: string;
+    markPx: string;
+    ts: string;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "1.3.6",
+  "version": "1.4.0",
   "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",