okx-api 0.0.2 → 0.0.5

package/lib/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./rest"), exports);
+//# sourceMappingURL=index.js.map

package/lib/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB"}

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

@@ -0,0 +1,32 @@
+import { InstrumentType } from '../shared';
+export interface SetLeverageRequest {
+    instId?: string;
+    ccy?: string;
+    lever: string;
+    mgnMode: 'isolated' | 'cross';
+    posSide?: 'long' | 'short';
+}
+export interface ChangePositionMarginRequest {
+    instId: string;
+    posSide: 'long' | 'short' | 'net';
+    type: 'add' | 'reduce';
+    amt: string;
+    ccy?: string;
+    auto?: boolean;
+    loanTrans?: boolean;
+}
+export interface GetPositionsParams {
+    instType?: InstrumentType;
+    instId?: string;
+    posId?: string;
+}
+export interface GetHistoricPositionParams {
+    instType?: InstrumentType;
+    instId?: string;
+    mgnMode?: string;
+    type?: string;
+    posId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}

package/lib/types/rest/request/{private-trade.js → account.js}

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

package/lib/types/rest/request/account.js.map

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

package/lib/types/rest/request/{private-block-trading.d.ts → block-trading.d.ts}

@@ -10,8 +10,8 @@ export interface CancelBlockRFQRequest {
     clRfqId?: string;
 }
 export interface CancelMultipleBlockRFQRequest {
-    rfqId?: string[];
-    clRfqId?: string[];
+    rfqIds?: string[];
+    clRfqIds?: string[];
 }
 export interface ExecuteBlockQuoteRequest {
     rfqId: string;
@@ -20,7 +20,7 @@ export interface ExecuteBlockQuoteRequest {
 export interface CreateBlockQuoteRequest {
     rfqId: string;
     clQuoteId?: string;
-    quoteSide: string;
+    quoteSide: OrderSide;
     anonymous?: boolean;
     expiresIn?: string;
     legs: CreateBlockQuoteLeg[];
@@ -37,8 +37,8 @@ export interface CancelBlockQuoteRequest {
     clQuoteId?: string;
 }
 export interface CancelMultipleBlockQuoteRequest {
-    quoteId?: string[];
-    clQuoteId?: string[];
+    quoteIds?: string[];
+    clQuoteIds?: string[];
 }
 export interface GetBlockRFQSParams {
     rfqId?: string;

package/lib/types/rest/request/{private-account.js → block-trading.js}

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

package/lib/types/rest/request/block-trading.js.map

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

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

@@ -0,0 +1,19 @@
+export interface ConvertQuoteEstimateRequest {
+    baseCcy: string;
+    quoteCcy: string;
+    side: string;
+    rfqSz: string;
+    rfqSzCcy: string;
+    clTReqId?: string;
+    tag?: string;
+}
+export interface ConvertTradeRequest {
+    quoteId: string;
+    baseCcy: string;
+    quoteCcy: string;
+    side: string;
+    sz: string;
+    szCcy: string;
+    clTReqId?: string;
+    tag?: string;
+}

package/lib/types/rest/request/{private-block-trading.js → convert.js}

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

package/lib/types/rest/request/convert.js.map

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

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

@@ -0,0 +1,21 @@
+export interface FundsTransferRequest {
+    ccy: string;
+    amt: string;
+    from: '6' | '18';
+    to: '6' | '16';
+    subAcct?: string;
+    type?: '0' | '1' | '2' | '3' | '4';
+    loanTrans?: boolean;
+    clientId?: string;
+    omitPosRisk?: string;
+}
+export interface WithdrawRequest {
+    ccy: string;
+    amt: string;
+    dest: '3' | '4';
+    toAddr: string;
+    fee: string;
+    chain?: string;
+    areaCode?: string;
+    clientId?: string;
+}

package/lib/types/rest/request/funding.js

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

package/lib/types/rest/request/funding.js.map

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

package/lib/types/rest/request/grid-trading.d.ts

@@ -0,0 +1,30 @@
+export declare type GridAlgoOrderType = 'grid' | 'contract_grid' | 'moon_grid';
+export interface GetGridAlgoOrdersRequest {
+    algoOrdType: GridAlgoOrderType;
+    algoId?: string;
+    instId?: string;
+    instType?: 'SPOT' | 'MARGIN' | 'SWAP' | 'FUTURES';
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface GridAlgoOrderRequest {
+    instId: string;
+    algoOrdType: GridAlgoOrderType;
+    maxPx: string;
+    minPx: string;
+    gridNum: string;
+    runType: '1' | '2';
+    quoteSz?: string;
+    baseSz?: string;
+    sz?: string;
+    direction?: 'long' | 'short' | 'neutral';
+    lever?: string;
+    basePos?: boolean;
+}
+export interface StopGridAlgoOrderRequest {
+    algoId: string;
+    instId: string;
+    algoOrdType: GridAlgoOrderType;
+    stopType: '1' | '2';
+}

package/lib/types/rest/request/grid-trading.js

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

package/lib/types/rest/request/grid-trading.js.map

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

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

@@ -1,4 +1,8 @@
+export * from './account';
+export * from './convert';
+export * from './funding';
 export * from './shared';
-export * from './private-account';
-export * from './private-trade';
-export * from './private-block-trading';
+export * from './subaccount';
+export * from './trade';
+export * from './block-trading';
+export * from './grid-trading';

package/lib/types/rest/request/index.js

@@ -14,8 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./account"), exports);
+__exportStar(require("./convert"), exports);
+__exportStar(require("./funding"), exports);
 __exportStar(require("./shared"), exports);
-__exportStar(require("./private-account"), exports);
-__exportStar(require("./private-trade"), exports);
-__exportStar(require("./private-block-trading"), exports);
+__exportStar(require("./subaccount"), exports);
+__exportStar(require("./trade"), exports);
+__exportStar(require("./block-trading"), exports);
+__exportStar(require("./grid-trading"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/rest/request/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/rest/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,oDAAkC;AAClC,kDAAgC;AAChC,0DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/rest/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,4CAA0B;AAC1B,4CAA0B;AAC1B,2CAAyB;AACzB,+CAA6B;AAC7B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B"}

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

@@ -0,0 +1,12 @@
+declare type AccountType = '6' | '18';
+export interface SubAccountTransferRequest {
+    ccy: string;
+    amt: string;
+    from: AccountType;
+    to: AccountType;
+    fromSubAccount: string;
+    toSubAccount: string;
+    loanTrans?: boolean;
+    omitPosRisk?: boolean;
+}
+export {};

package/lib/types/rest/request/subaccount.js

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

package/lib/types/rest/request/subaccount.js.map

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

package/lib/types/rest/request/{private-trade.d.ts → trade.d.ts}

@@ -103,9 +103,11 @@ export interface OrderRequest {
     side: OrderSide;
     posSide?: PositionSide;
     ordType: OrderType;
+    /** Quantity to buy or sell */
     sz: numberInString;
     px?: string;
     reduceOnly?: boolean;
-    tgtCcy?: string;
+    /** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
+    tgtCcy?: 'base_ccy' | 'quote_ccy';
     banAmend?: boolean;
 }

package/lib/types/rest/request/trade.js

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

package/lib/types/rest/request/trade.js.map

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

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

@@ -1,3 +1,4 @@
+import { ASSET_BILL_TYPE } from '../../../constants';
 export interface FundingCurrency {
     canDep: boolean;
     canInternal: boolean;
@@ -62,6 +63,6 @@ export interface AssetBillDetails {
     clientId: string;
     balChg: string;
     bal: string;
-    type: string;
+    type: `${ASSET_BILL_TYPE}`;
     ts: string;
 }

package/lib/types/rest/shared.d.ts

@@ -7,7 +7,6 @@ export interface APIResponse<T> {
 export declare type AlgoOrderType = 'conditional' | 'oco' | 'trigger' | 'move_order_stop' | 'iceberg' | 'twap';
 export declare type AlgoState = 'effective' | 'canceled' | 'order_failed';
 export declare type ContractGridDirection = 'long' | 'short' | 'neutral';
-export declare type GridAlgoOrderType = 'grid' | 'contract_grid';
 export declare type GridAlgoSubOrderType = 'live' | 'filled';
 export declare type InstrumentType = 'SPOT' | 'MARGIN' | 'SWAP' | 'FUTURES' | 'OPTION';
 export declare type MarginMode = 'cross' | 'isolated';
@@ -34,3 +33,8 @@ export declare type TradeMode = 'cross' | 'isolated' | 'cash';
 export interface TimestampObject {
     ts: numberInString;
 }
+export interface Pagination {
+    after?: string;
+    before?: string;
+    limit?: string;
+}

package/lib/util/BaseRestClient.d.ts

@@ -4,7 +4,7 @@ export declare const MISSING_CREDENTIALS_ERROR = "Private endpoints require api
 export interface APICredentials {
     apiKey: string;
     apiSecret: string;
-    apiPassphrase: string;
+    apiPass: string;
 }
 export default abstract class BaseRestClient {
     private options;
@@ -13,7 +13,6 @@ export default abstract class BaseRestClient {
     private apiKey;
     private apiSecret;
     private apiPassphrase;
-    private environment;
     constructor(credentials: APICredentials | undefined | null, baseUrl: string, options: RestClientOptions | undefined, requestOptions: AxiosRequestConfig | undefined, environment: OKXEnvironment);
     get(endpoint: string, params?: any): Promise<any>;
     post(endpoint: string, params?: any): Promise<any>;

package/lib/util/BaseRestClient.js

@@ -39,17 +39,16 @@ const typeGuards_1 = require("./typeGuards");
 // });
 exports.MISSING_CREDENTIALS_ERROR = 'Private endpoints require api and secret to be provided in the REST client constructor';
 class BaseRestClient {
+    // private environment: OKXEnvironment;
     constructor(credentials, baseUrl, options = {}, requestOptions = {}, environment) {
-        this.environment = environment;
+        // this.environment = environment;
         this.options = Object.assign({ 
             // if true, we'll throw errors if any params are undefined
             strict_param_validation: false }, options);
         this.baseUrl = baseUrl;
         // Allow empty object
         if (credentials &&
-            (!credentials.apiKey ||
-                !credentials.apiSecret ||
-                !credentials.apiPassphrase)) {
+            (!credentials.apiKey || !credentials.apiSecret || !credentials.apiPass)) {
             throw new Error('API Key, Secret AND Passphrase are ALL required for private enpoints');
         }
         this.globalRequestOptions = Object.assign({ 
@@ -63,7 +62,7 @@ class BaseRestClient {
         this.globalRequestOptions.headers['Accept'] = 'application/json';
         this.apiKey = credentials === null || credentials === void 0 ? void 0 : credentials.apiKey;
         this.apiSecret = credentials === null || credentials === void 0 ? void 0 : credentials.apiSecret;
-        this.apiPassphrase = credentials === null || credentials === void 0 ? void 0 : credentials.apiPassphrase;
+        this.apiPassphrase = credentials === null || credentials === void 0 ? void 0 : credentials.apiPass;
     }
     // private isDemoTrading(): boolean {
     //   return this.environment === 'demo';
@@ -116,6 +115,7 @@ class BaseRestClient {
             //   method,
             //   params: signResult.requestBody,
             //   sign: signResult.sign,
+            //   options,
             // });
             return (0, axios_1.default)(options)
                 .then((response) => {

package/lib/util/BaseRestClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAAyE;AAEzE,iDAA6C;AAE7C,iDAMwB;AACxB,6CAAgD;AAEhD,gDAAgD;AAChD,mFAAmF;AACnF,oBAAoB;AACpB,MAAM;AAEN,kDAAkD;AAClD,gFAAgF;AAChF,iBAAiB;AACjB,kBAAkB;AAClB,mBAAmB;AACnB,sBAAsB;AACtB,UAAU;AACV,+BAA+B;AAC/B,qCAAqC;AACrC,WAAW;AACX,cAAc;AACd,UAAU;AACV,QAAQ;AACR,OAAO;AACP,qBAAqB;AACrB,MAAM;AAEO,QAAA,yBAAyB,GACpC,wFAAwF,CAAC;AAe3F,MAA8B,cAAc;IAU1C,YACE,WAA8C,EAC9C,OAAe,EACf,UAA6B,EAAE,EAC/B,iBAAqC,EAAE,EACvC,WAA2B;QAE3B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAE/B,IAAI,CAAC,OAAO;YACV,0DAA0D;YAC1D,uBAAuB,EAAE,KAAK,IAC3B,OAAO,CACX,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,qBAAqB;QACrB,IACE,WAAW;YACX,CAAC,CAAC,WAAW,CAAC,MAAM;gBAClB,CAAC,WAAW,CAAC,SAAS;gBACtB,CAAC,WAAW,CAAC,aAAa,CAAC,EAC7B;YACA,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;SACH;QAED,IAAI,CAAC,oBAAoB;YACvB,gCAAgC;YAChC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,EACtB,OAAO,EAAE,EAAE,IAER,cAAc,CAClB,CAAC;QAEF,+FAA+F;QAC/F,IAAI,WAAW,KAAK,MAAM,EAAE;YAC1B,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;SAC9D;QACD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACvE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC;QAEjE,IAAI,CAAC,MAAM,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,CAAC;IAClD,CAAC;IAED,qCAAqC;IACrC,wCAAwC;IACxC,IAAI;IAEG,GAAG,CAAC,QAAgB,EAAE,MAAY;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,IAAI,CAAC,QAAgB,EAAE,MAAY;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAEM,UAAU,CAAC,QAAgB,EAAE,MAAY;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,QAAgB,EAAE,MAAY;QAC/C,OAAO,IAAI,CAAC,KAAK,CACf,MAAM,EACN,QAAQ,EACR,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YACnB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAM,CAAC,KAAE,CAAC,yBAAU,CAAC,EAAE,wBAAS,IAAG,CAAC;YACxD,CAAC,iCAAM,MAAM,KAAE,CAAC,yBAAU,CAAC,EAAE,wBAAS,GAAE,EAC1C,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,aAAa,CAAC,QAAgB,EAAE,MAAY;QACjD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACW,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAAsB,EACtB,WAAoB;;YAEpB,MAAM,OAAO,mCACR,IAAI,CAAC,oBAAoB,KAC5B,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EACvE,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,GACX,CAAC;YAEF,kCAAkC;YAClC,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACtC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;aACF;YAED,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CACvC,WAAW,EACX,KAAK,EACL,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;YAEF,IAAI,CAAC,WAAW,EAAE;gBAChB,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC/C,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;gBACpD,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC;gBAC/C,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;aAC9D;YAED,IAAI,MAAM,KAAK,KAAK,EAAE;gBACpB,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC;aACzC;iBAAM;gBACL,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC;aACvC;YAED,yCAAyC;YACzC,sBAAsB;YACtB,YAAY;YACZ,oCAAoC;YACpC,2BAA2B;YAC3B,MAAM;YAEN,OAAO,IAAA,eAAK,EAAC,OAAO,CAAC;iBAClB,IAAI,CAAC,CAAC,QAA6C,EAAE,EAAE;;gBACtD,uDAAuD;gBACvD,6EAA6E;gBAC7E,IACE,IAAA,6BAAgB,EAAC,QAAQ,CAAC,IAAI,CAAC;oBAC/B,QAAQ,CAAC,MAAM,IAAI,GAAG;oBACtB,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,MAAK,GAAG,EAC3B;oBACA,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC3B;gBAED,8DAA8D;gBAC9D,eAAe;gBACf,sBAAsB;gBACtB,oBAAoB;gBACpB,QAAQ;gBACR,6BAA6B;gBAC7B,mCAAmC;gBACnC,SAAS;gBACT,YAAY;gBACZ,QAAQ;gBACR,MAAM;gBACN,KAAK;gBAEL,wCAAwC;gBACxC,uFAAuF;gBACvF,MAAM,EAAE,QAAQ,EAAE,CAAC;YACrB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;OAEG;IACW,WAAW,CACvB,WAAoB,EACpB,KAAa,EACb,MAAc,EACd,QAAgB,EAChB,MAAqB;;YAErB,MAAM,GAAG,GAAqB;gBAC5B,WAAW,EAAE,MAAM;gBACnB,MAAM;gBACN,QAAQ;gBACR,IAAI,EAAE,EAAE;aACT,CAAC;YAEF,IAAI,WAAW,EAAE;gBACf,OAAO,GAAG,CAAC;aACZ;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,iCAAyB,CAAC,CAAC;aAC5C;YAED,MAAM,gBAAgB,GAAG,IAAA,8BAAe,EACtC,MAAM,EACN,MAAM,EACN,IAAI,CAAC,OAAO,CAAC,uBAAuB,CACrC,CAAC;YAEF,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,CAAC;YAC7D,6CAA6C;YAC7C,aAAa;YACb,4BAA4B;YAC5B,MAAM;YAEN,uCACK,GAAG,KACN,IAAI,EAAE,IAAA,0BAAW,EAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAC1C;QACJ,CAAC;KAAA;IAED;;OAEG;IACK,cAAc,CAAC,CAAM;QAC3B,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,KAAK,EAAE;YAC3C,MAAM,CAAC,CAAC;SACT;QAED,uEAAuE;QACvE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACd,MAAM,CAAC,CAAC,OAAO,CAAC;aACjB;YAED,wCAAwC;YACxC,MAAM,CAAC,CAAC;SACT;QAED,mEAAmE;QACnE,qCAAqC;QACrC,MAAM,QAAQ,GAAkB,CAAC,CAAC,QAAQ,CAAC;QAC3C,MAAM,QAAQ,CAAC,IAAI,CAAC;QACpB,UAAU;QACV,6BAA6B;QAC7B,qCAAqC;QACrC,yBAAyB;QACzB,+BAA+B;QAC/B,kCAAkC;QAClC,KAAK;IACP,CAAC;CACF;AAvPD,iCAuPC"}
+{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAAyE;AAEzE,iDAA6C;AAC7C,iDAMwB;AACxB,6CAAgD;AAEhD,gDAAgD;AAChD,mFAAmF;AACnF,oBAAoB;AACpB,MAAM;AAEN,kDAAkD;AAClD,gFAAgF;AAChF,iBAAiB;AACjB,kBAAkB;AAClB,mBAAmB;AACnB,sBAAsB;AACtB,UAAU;AACV,+BAA+B;AAC/B,qCAAqC;AACrC,WAAW;AACX,cAAc;AACd,UAAU;AACV,QAAQ;AACR,OAAO;AACP,qBAAqB;AACrB,MAAM;AAEO,QAAA,yBAAyB,GACpC,wFAAwF,CAAC;AAe3F,MAA8B,cAAc;IAQ1C,uCAAuC;IAEvC,YACE,WAA8C,EAC9C,OAAe,EACf,UAA6B,EAAE,EAC/B,iBAAqC,EAAE,EACvC,WAA2B;QAE3B,kCAAkC;QAElC,IAAI,CAAC,OAAO;YACV,0DAA0D;YAC1D,uBAAuB,EAAE,KAAK,IAC3B,OAAO,CACX,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,qBAAqB;QACrB,IACE,WAAW;YACX,CAAC,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EACvE;YACA,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;SACH;QAED,IAAI,CAAC,oBAAoB;YACvB,gCAAgC;YAChC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,EACtB,OAAO,EAAE,EAAE,IAER,cAAc,CAClB,CAAC;QAEF,+FAA+F;QAC/F,IAAI,WAAW,KAAK,MAAM,EAAE;YAC1B,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;SAC9D;QACD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACvE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC;QAEjE,IAAI,CAAC,MAAM,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC;IAC5C,CAAC;IAED,qCAAqC;IACrC,wCAAwC;IACxC,IAAI;IAEG,GAAG,CAAC,QAAgB,EAAE,MAAY;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,IAAI,CAAC,QAAgB,EAAE,MAAY;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAEM,UAAU,CAAC,QAAgB,EAAE,MAAY;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,QAAgB,EAAE,MAAY;QAC/C,OAAO,IAAI,CAAC,KAAK,CACf,MAAM,EACN,QAAQ,EACR,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YACnB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAM,CAAC,KAAE,CAAC,yBAAU,CAAC,EAAE,wBAAS,IAAG,CAAC;YACxD,CAAC,iCAAM,MAAM,KAAE,CAAC,yBAAU,CAAC,EAAE,wBAAS,GAAE,EAC1C,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,aAAa,CAAC,QAAgB,EAAE,MAAY;QACjD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACW,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAAsB,EACtB,WAAoB;;YAEpB,MAAM,OAAO,mCACR,IAAI,CAAC,oBAAoB,KAC5B,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EACvE,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,GACX,CAAC;YAEF,kCAAkC;YAClC,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACtC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;aACF;YAED,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CACvC,WAAW,EACX,KAAK,EACL,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;YAEF,IAAI,CAAC,WAAW,EAAE;gBAChB,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC/C,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;gBACpD,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC;gBAC/C,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;aAC9D;YAED,IAAI,MAAM,KAAK,KAAK,EAAE;gBACpB,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC;aACzC;iBAAM;gBACL,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC;aACvC;YAED,yCAAyC;YACzC,sBAAsB;YACtB,YAAY;YACZ,oCAAoC;YACpC,2BAA2B;YAC3B,aAAa;YACb,MAAM;YAEN,OAAO,IAAA,eAAK,EAAC,OAAO,CAAC;iBAClB,IAAI,CAAC,CAAC,QAA6C,EAAE,EAAE;;gBACtD,uDAAuD;gBACvD,6EAA6E;gBAC7E,IACE,IAAA,6BAAgB,EAAC,QAAQ,CAAC,IAAI,CAAC;oBAC/B,QAAQ,CAAC,MAAM,IAAI,GAAG;oBACtB,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,MAAK,GAAG,EAC3B;oBACA,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC3B;gBAED,8DAA8D;gBAC9D,eAAe;gBACf,sBAAsB;gBACtB,oBAAoB;gBACpB,QAAQ;gBACR,6BAA6B;gBAC7B,mCAAmC;gBACnC,SAAS;gBACT,YAAY;gBACZ,QAAQ;gBACR,MAAM;gBACN,KAAK;gBAEL,wCAAwC;gBACxC,uFAAuF;gBACvF,MAAM,EAAE,QAAQ,EAAE,CAAC;YACrB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;OAEG;IACW,WAAW,CACvB,WAAoB,EACpB,KAAa,EACb,MAAc,EACd,QAAgB,EAChB,MAAqB;;YAErB,MAAM,GAAG,GAAqB;gBAC5B,WAAW,EAAE,MAAM;gBACnB,MAAM;gBACN,QAAQ;gBACR,IAAI,EAAE,EAAE;aACT,CAAC;YAEF,IAAI,WAAW,EAAE;gBACf,OAAO,GAAG,CAAC;aACZ;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,iCAAyB,CAAC,CAAC;aAC5C;YAED,MAAM,gBAAgB,GAAG,IAAA,8BAAe,EACtC,MAAM,EACN,MAAM,EACN,IAAI,CAAC,OAAO,CAAC,uBAAuB,CACrC,CAAC;YAEF,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,CAAC;YAC7D,6CAA6C;YAC7C,aAAa;YACb,4BAA4B;YAC5B,MAAM;YAEN,uCACK,GAAG,KACN,IAAI,EAAE,IAAA,0BAAW,EAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAC1C;QACJ,CAAC;KAAA;IAED;;OAEG;IACK,cAAc,CAAC,CAAM;QAC3B,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,KAAK,EAAE;YAC3C,MAAM,CAAC,CAAC;SACT;QAED,uEAAuE;QACvE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACd,MAAM,CAAC,CAAC,OAAO,CAAC;aACjB;YAED,wCAAwC;YACxC,MAAM,CAAC,CAAC;SACT;QAED,mEAAmE;QACnE,qCAAqC;QACrC,MAAM,QAAQ,GAAkB,CAAC,CAAC,QAAQ,CAAC;QAC3C,MAAM,QAAQ,CAAC,IAAI,CAAC;QACpB,UAAU;QACV,6BAA6B;QAC7B,qCAAqC;QACrC,yBAAyB;QACzB,+BAA+B;QAC/B,kCAAkC;QAClC,KAAK;IACP,CAAC;CACF;AAtPD,iCAsPC"}

package/lib/util/requestUtils.js

@@ -8,17 +8,17 @@ function serializeParams(params, method, strict_validation = false) {
     if (method !== 'GET') {
         return JSON.stringify(params);
     }
-    // Original order should be preserved, no sorting allowed here or sign will fail
-    return ('?' +
-        Object.keys(params)
-            .map((key) => {
-            const value = params[key];
-            if (strict_validation === true && typeof value === 'undefined') {
-                throw new Error('Failed to sign API request due to undefined parameter');
-            }
-            return `${key}=${value}`;
-        })
-            .join('&'));
+    const queryString = Object.keys(params)
+        .map((key) => {
+        const value = params[key];
+        if (strict_validation === true && typeof value === 'undefined') {
+            throw new Error('Failed to sign API request due to undefined parameter');
+        }
+        return `${key}=${value}`;
+    })
+        .join('&');
+    // Prevent trailing `?` if no params are provided
+    return queryString ? '?' + queryString : queryString;
 }
 exports.serializeParams = serializeParams;
 exports.programKey = 'tag';

package/lib/util/requestUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../src/util/requestUtils.ts"],"names":[],"mappings":";;;AAcA,SAAgB,eAAe,CAC7B,MAA0B,EAC1B,MAAc,EACd,iBAAiB,GAAG,KAAK;IAEzB,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,CAAC;KACX;IAED,IAAI,MAAM,KAAK,KAAK,EAAE;QACpB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KAC/B;IAED,gFAAgF;IAChF,OAAO,CACL,GAAG;QACH,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aAChB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;gBAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;aACH;YACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;QAC3B,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,CAAC,CACb,CAAC;AACJ,CAAC;AA5BD,0CA4BC;AACY,QAAA,UAAU,GAAG,KAAK,CAAC;AACnB,QAAA,SAAS,GAAG,kBAAkB,CAAC;AAS5C,SAAgB,cAAc,CAC5B,WAA2B,EAC3B,iBAAoC;IAEpC,IAAI,iBAAiB,CAAC,OAAO,EAAE;QAC7B,OAAO,iBAAiB,CAAC,OAAO,CAAC;KAClC;IAED,QAAQ,WAAW,EAAE;QACnB,QAAQ;QACR,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,qBAAqB,CAAC;SAC9B;QACD,KAAK,KAAK,CAAC,CAAC;YACV,OAAO,sBAAsB,CAAC;SAC/B;KACF;AACH,CAAC;AAlBD,wCAkBC;AAED,SAAgB,QAAQ,CAAC,QAAa;IACpC,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CACL,QAAQ,CAAC,OAAO;QAChB,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM;QAC9B,QAAQ,CAAC,OAAO,KAAK,MAAM;QAC3B,QAAQ,CAAC,OAAO,KAAK,IAAI,CAC1B,CAAC;AACJ,CAAC;AAVD,4BAUC"}
+{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../src/util/requestUtils.ts"],"names":[],"mappings":";;;AAcA,SAAgB,eAAe,CAC7B,MAA0B,EAC1B,MAAc,EACd,iBAAiB,GAAG,KAAK;IAEzB,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,CAAC;KACX;IAED,IAAI,MAAM,KAAK,KAAK,EAAE;QACpB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KAC/B;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;YAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;SACH;QACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;IAC3B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iDAAiD;IACjD,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AACvD,CAAC;AA3BD,0CA2BC;AACY,QAAA,UAAU,GAAG,KAAK,CAAC;AACnB,QAAA,SAAS,GAAG,kBAAkB,CAAC;AAS5C,SAAgB,cAAc,CAC5B,WAA2B,EAC3B,iBAAoC;IAEpC,IAAI,iBAAiB,CAAC,OAAO,EAAE;QAC7B,OAAO,iBAAiB,CAAC,OAAO,CAAC;KAClC;IAED,QAAQ,WAAW,EAAE;QACnB,QAAQ;QACR,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,qBAAqB,CAAC;SAC9B;QACD,KAAK,KAAK,CAAC,CAAC;YACV,OAAO,sBAAsB,CAAC;SAC/B;KACF;AACH,CAAC;AAlBD,wCAkBC;AAED,SAAgB,QAAQ,CAAC,QAAa;IACpC,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CACL,QAAQ,CAAC,OAAO;QAChB,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM;QAC9B,QAAQ,CAAC,OAAO,KAAK,MAAM;QAC3B,QAAQ,CAAC,OAAO,KAAK,IAAI,CAC1B,CAAC;AACJ,CAAC;AAVD,4BAUC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "okx-api",
-  "version": "0.0.2",
-  "description": "EARLY BETA. Node.js connector for OKX REST APIs and WebSockets, with TypeScript & integration tests.",
+  "version": "0.0.5",
+  "description": "Node.js connector for OKX REST APIs and WebSockets, with TypeScript & integration tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [

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

@@ -1,16 +0,0 @@
-import { InstrumentType } from '../shared';
-export interface GetPositionsParams {
-    instType?: InstrumentType;
-    instId?: string;
-    posId?: string;
-}
-export interface GetHistoricPositionParams {
-    instType?: InstrumentType;
-    instId?: string;
-    mgnMode?: string;
-    type?: string;
-    posId?: string;
-    after?: string;
-    before?: string;
-    limit?: string;
-}

package/lib/types/rest/request/private-account.js.map

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

package/lib/types/rest/request/private-block-trading.js.map

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

package/lib/types/rest/request/private-trade.js.map

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